Send a test email through the configured SMTP relay

POST

/admin/system/smtp/test

• Local development behind nginx (port 8088 by default)

Renders the admin_test template + sends it via the currently configured Sender (SMTP / capture / disabled per the boot mode). The recipient defaults to the calling admin’s own email; an explicit to overrides for diagnosing relay-side routing issues.

Synchronous — the response carries the outcome (sent + delivery mode) so the operator sees the failure immediately instead of digging in the job queue.

Gated on system.config.write (same gate as the SMTP config-write surface).

Authorizations

• cookieAuth
• bearerAuth

Request Body

object

to

Recipient override. When omitted, the server uses the calling admin’s email on file. Useful for diagnosing relay-side routing (e.g. send to an external Gmail account to verify deliverability).

string format: email

Responses

200

Test email accepted by the configured Sender.

object

sent

required

True when the Sender accepted the message.

boolean

mode

required

The boot-time Sender mode (informational).

string

Allowed values: smtp capture disabled

recipient

required

The email the test was sent to.

string

message

Human-readable summary (e.g. “captured locally; not delivered”).

string

400

Malformed request

object

error

required

Human-readable error summary

string

Example

the request could not be completed

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed

503

SMTP not configured (relay host empty).

object

error

required

Human-readable error summary

string

Example

the request could not be completed