v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01121113461.4 KB
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_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.