Sign in
config

Return a dictionary of public settings for the frontend to consume.

get/api/v1.0/config/

Response

A dictionary of public configuration settings.

ENVIRONMENTstring required
RELEASEstring required

Version of the application

LANGUAGE_CODEstring required
AI_ENABLEDboolean required
FEATURE_AI_SUMMARYboolean required
FEATURE_AI_AUTOLABELSboolean required
FEATURE_MAILBOX_ADMIN_CHANNELSstring[] required
SCHEMA_CUSTOM_ATTRIBUTES_USERobject required
SCHEMA_CUSTOM_ATTRIBUTES_MAILDOMAINobject required
MAX_OUTGOING_ATTACHMENT_SIZEinteger required

Maximum size in bytes for outgoing email attachments

MAX_RECIPIENTS_PER_MESSAGEinteger required

Maximum number of recipients per message (to + cc + bcc)

MAX_TEMPLATE_IMAGE_SIZEinteger required

Maximum size in bytes for images embedded in templates and signatures

IMAGE_PROXY_ENABLEDboolean required

Whether external images should be proxied

MESSAGE_TRUSTED_LINK_DOMAINSstring[] required

Hostnames whose external links skip the redirect confirmation modal (a leading *. wildcard also matches subdomains)

FEATURE_MAILDOMAIN_CREATEboolean required
FEATURE_MAILDOMAIN_MANAGE_ACCESSESboolean required
FEATURE_THREAD_SPLITboolean required
FEATURE_THREAD_SNIPPETboolean required
FEATURE_MAILDOMAIN_MANAGE_TOTPboolean required
MESSAGES_MANUAL_RETRY_MAX_AGEinteger required

Maximum age in seconds for a message to be eligible for manual retry of failed deliveries

FRONTEND_SILENT_LOGIN_ENABLEDboolean required

Whether silent OIDC login is enabled

SENTRY_DSNstring

Sentry DSN shared with the frontend

FRONTEND_THEME_CONFIGobject

Theme configuration for the frontend (theme, terms_of_service_url, footer)

FRONTEND_FORCED_DEFAULT_LANGUAGEboolean

Whether the frontend should fall back to LANGUAGE_CODE instead of the browser language

FRONTEND_MULTIPART_UPLOAD_CHUNK_SIZE_MBinteger

Chunk size in MB for frontend multipart uploads

FRONTEND_HELP_CENTER_URLstring

Help center URL

MOBILE_OTA_MANIFEST_URLstring

OTA channel manifest URL the mobile apps poll at startup; unset disables OTA updates

PUSH_ENABLEDboolean required

Whether push notifications are available on this deployment (gates the device-registration UI).

PUSH_VAPID_PUBLIC_KEYstring

VAPID public key (base64url) the web client passes as applicationServerKey to subscribe; null when Web Push is not configured.

Changes

Changed in 19 of the 54 revisions of this API.121155

  • cdee850192844See the full diff
    • ○

      added the optional property MOBILE_OTA_MANIFEST_URL to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property PUSH_VAPID_PUBLIC_KEY to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property FEATURE_THREAD_SNIPPET to the response with the 200 status

      response-required-property-added

    • ○

      added the required property PUSH_ENABLED to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b5805341bbf31See the full diff
    • ●

      removed the optional property MOBILE_OTA_MANIFEST_URL from the response with the 200 status

      response-optional-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 978f762ac3a91See the full diff
    • ○

      added the optional property MOBILE_OTA_MANIFEST_URL to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b5805341bbf31See the full diff
    • ○

      added the required property MESSAGE_TRUSTED_LINK_DOMAINS to the response with the 200 status

      response-required-property-added

  • d0b2f742587e11See the full diff
    • ▲

      removed the required property MESSAGE_TRUSTED_LINK_DOMAINS from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property MOBILE_OTA_MANIFEST_URL from the response with the 200 status

      response-optional-property-removed

  • 4799a977eda01See the full diff
    • ○

      added the optional property MOBILE_OTA_MANIFEST_URL to the response with the 200 status

      response-optional-property-added

  • 4461d7f79179314See the full diff
    • ▲

      the LANGUAGES/items/ response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • ▲

      removed the required property MAX_INCOMING_EMAIL_SIZE from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property MAX_OUTGOING_BODY_SIZE from the response with the 200 status

      response-required-property-removed

    • ○

      added the optional property FRONTEND_FEEDBACK_WIDGET_CONFIG to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_FORCED_DEFAULT_LANGUAGE to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_HELP_CENTER_URL to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_LAGAUFRE_WIDGET_CONFIG to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_MULTIPART_UPLOAD_CHUNK_SIZE_MB to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_THEME_CONFIG to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property SENTRY_DSN to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property MESSAGE_TRUSTED_LINK_DOMAINS to the response with the 200 status

      response-required-property-added

    • ○

      added the required property RELEASE to the response with the 200 status

      response-required-property-added

    • ○

      the response required property DRIVE/api_url became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property DRIVE/app_name became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property DRIVE/file_url became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property DRIVE/preview_url became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property DRIVE/sdk_url became not read-only for the status 200

      response-required-property-became-not-read-only

  • 1f0c8e2644b9497See the full diff
    • ▲

      the LANGUAGES/items/ response's property type/format changed from array/ to string/ for status 200

      response-property-type-changed

    • ▲

      removed the required property MESSAGE_TRUSTED_LINK_DOMAINS from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property PUSH_ENABLED from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property RELEASE from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property FRONTEND_FEEDBACK_WIDGET_CONFIG from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property FRONTEND_FORCED_DEFAULT_LANGUAGE from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property FRONTEND_HELP_CENTER_URL from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property FRONTEND_LAGAUFRE_WIDGET_CONFIG from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property FRONTEND_MULTIPART_UPLOAD_CHUNK_SIZE_MB from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property FRONTEND_THEME_CONFIG from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property MOBILE_OTA_MANIFEST_URL from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property PUSH_VAPID_PUBLIC_KEY from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property SENTRY_DSN from the response with the 200 status

      response-optional-property-removed

    • ○

      added the required property MAX_INCOMING_EMAIL_SIZE to the response with the 200 status

      response-required-property-added

    • ○

      added the required property MAX_OUTGOING_BODY_SIZE to the response with the 200 status

      response-required-property-added

    • ○

      the response required property DRIVE/api_url became read-only for the status 200

      response-required-property-became-read-only

    • ○

      the response required property DRIVE/app_name became read-only for the status 200

      response-required-property-became-read-only

    • ○

      the response required property DRIVE/file_url became read-only for the status 200

      response-required-property-became-read-only

    • ○

      the response required property DRIVE/preview_url became read-only for the status 200

      response-required-property-became-read-only

    • ○

      the response required property DRIVE/sdk_url became read-only for the status 200

      response-required-property-became-read-only

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5c64242ea839317See the full diff
    • ▲

      the LANGUAGES/items/ response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • ▲

      removed the required property MAX_INCOMING_EMAIL_SIZE from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property MAX_OUTGOING_BODY_SIZE from the response with the 200 status

      response-required-property-removed

    • ○

      added the optional property FRONTEND_FEEDBACK_WIDGET_CONFIG to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_FORCED_DEFAULT_LANGUAGE to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_HELP_CENTER_URL to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_LAGAUFRE_WIDGET_CONFIG to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_MULTIPART_UPLOAD_CHUNK_SIZE_MB to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property FRONTEND_THEME_CONFIG to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property MOBILE_OTA_MANIFEST_URL to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property PUSH_VAPID_PUBLIC_KEY to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property SENTRY_DSN to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property MESSAGE_TRUSTED_LINK_DOMAINS to the response with the 200 status

      response-required-property-added

    • ○

      added the required property PUSH_ENABLED to the response with the 200 status

      response-required-property-added

    • ○

      added the required property RELEASE to the response with the 200 status

      response-required-property-added

    • ○

      the response required property DRIVE/api_url became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property DRIVE/app_name became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property DRIVE/file_url became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property DRIVE/preview_url became not read-only for the status 200

      response-required-property-became-not-read-only

    • ○

      the response required property DRIVE/sdk_url became not read-only for the status 200

      response-required-property-became-not-read-only

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • faf779aa683e1See the full diff
    • ○

      added the required property DRIVE/preview_url to the response with the 200 status

      response-required-property-added