Skip to content

Send a test email

POST
/v1/settings/test/smtp
curl --request POST \
--url http://localhost:8080/v1/settings/test/smtp \
--header 'Content-Type: application/json' \
--data '{ "recipient": "example" }'

Sends a real message to recipient through the configured SMTP relay and reports whether the relay accepted it; the outcome updates the wizard flag setup.smtp_tested, which activation requires. Administrators only.

Media typeapplication/json
object
recipient
string
Examplegenerated
{
"recipient": "example"
}

OK

Media typeapplication/json
object
accepted
required
boolean
detail
required
string
Examplegenerated
{
"accepted": true,
"detail": "example"
}