Instance Email

Send a test email

Sends a test email through the configured relay to the given address, or to the caller's verified address when none is given.

post/admin/email/test

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/email/test
  • Auth: HTTP bearer

Request body

tostring email

the mailbox to send the test email to; blank means the caller's own verified address

Response

Email delivery outcome

messageIdstring

the accepted <code>Message-ID</code>, only for <code>SENT</code>; search for it in the relay's log

outcome'SENT' | 'EXPIRED' | 'NOT_CONFIGURED' | 'SILENT_MODE' | 'NO_RECIPIENT' | 'UNSUBSCRIBED' | 'INVALID_ADDRESS' | 'REJECTED' | 'UNAVAILABLE' | 'RATE_LIMITED' required

what became of the test email; <code>SENT</code> is the only success

tostring

the address it went to, or <code>null</code> when there was no recipient to resolve

Changes

No recorded changes to this operation across all 50 revisions of this API.