settings

Send a test email using current SMTP settings (admin/superadmin)

post/settings/test-email

Request

Base URL
/api/v1 (relative, and the document was published on a file host, not at the API’s origin)
URL
/api/v1/settings/test-email
Auth
HTTP bearer

tostring required

systemEmailHoststring

systemEmailPortnumber

systemEmailSecureboolean

systemEmailPoolboolean

systemEmailAddressstring

systemEmailDisplayNamestring

systemEmailPasswordstring

systemEmailUserstring

systemEmailIgnoreTLSboolean

systemEmailRequireTLSboolean

systemEmailRejectUnauthorizedboolean

successtrue required

msgstring required

Oct 7, 2026ad325aec1bdf Revision changes
- info
  added the non-success response with the status
Oct 1, 2026e1e4b18d0319 Revision changes
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status