---
title: "Send Test Mail"
method: POST
path: "/v1/settings/mail/test"
tags: ["settings"]
---

# Send Test Mail

`POST /v1/settings/mail/test`

Send one templated test message to prove the configuration works.

Refuses with 503 when the deployment cannot send a linked message, naming
the missing settings; the dashboard disables the control in that state, so
reaching this is a direct API call or a race with a configuration change.

The recipient is the only caller-supplied value: the body is a fixed
template, so this cannot be used to put chosen text in someone's inbox from
the deployment's own address, and the message says outright that no account
was created for whoever receives it.

## Request body

- SendTestMailRequest — Where to send the test message.
  - `to` string, email, required — Recipient of the test message.

## Response `200`

Successful Response

- SendTestMailResponse — The outcome of one test send. ``reason`` carries the transport's own error text, which is the whole value of a test button (an operator needs to know it was a refused login rather than a wrong port). Safe here and only here: this endpoint is master-key gated, unlike the public error paths that must not leak internals.
  - `ok` boolean, required
  - `reason` string, nullable
  - `transport` string, required

## Other responses

- `422` — Validation Error

---

[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)
