---
title: "Get Mail Settings"
method: GET
path: "/v1/settings/mail"
tags: ["settings"]
---

# Get Mail Settings

`GET /v1/settings/mail`

Report the effective outgoing-mail configuration.

## Response `200`

Successful Response

- MailSettings — What this deployment can send, and what stands in the way if it cannot.
  - `enabled` boolean, required — Whether a transport is configured at all.
  - `from_email` string, nullable, required — The 'From' address on outgoing mail, if one is configured.
  - `from_name` string, required — The 'From' display name on outgoing mail.
  - `missing` string[], 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_url` string, nullable, required — This deployment's own externally-reachable URL, used to build links in outgoing mail.
  - `ready` boolean, 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 /v1/bootstrap.
  - `transport` string, required — The transport a send would use: 'smtp', 'console' (logged, not delivered), or 'none'.

---

[API](https://skmtc.net/mozilla-ai/apis/otari.md) · [All operations](https://skmtc.net/mozilla-ai/apis/otari/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mozilla-ai/otari/revisions/2d6e4912e230/schema)