Sign in
settings

Get Mail Settings

Changed on

Report the effective outgoing-mail configuration.

get/api/v1/settings/mail

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Response

Successful Response

enabledboolean required

Whether a transport is configured at all.

from_emailstring nullable required

The 'From' address on outgoing mail, if one is configured.

from_namestring required

The 'From' display name on outgoing mail.

missingstring[] required

Settings that must be set before mail works, in config order. Empty exactly when 'ready' is true, so the dashboard can name what to configure rather than only reporting that mail is off.

public_base_urlstring nullable required

This deployment's own externally-reachable URL, which mail needs before it can send. The links themselves are built from ui_base_url, or from this when that is unset.

readyboolean required

Whether a message carrying a link back to this deployment can be sent, which is what every message the control plane sends needs. Matches 'mail_ready' on /api/v1/bootstrap.

transportstring required

The transport a send would use: 'smtp', 'console' (logged, not delivered), or 'none'.

Changes