Config

Test SMTP configuration

Sends a test email to verify the SMTP is configured correctly. Only available when SMTP is configured via the UI.

post/config/test-smtp

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/config/test-smtp
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Response

Test email sent successfully

Example response

{
  "item": {
    "id": "1",
    "smtpHost": "smtp.example.com",
    "smtpPort": 587,
    "smtpName": "localhost",
    "smtpTlsRejectUnauthorized": true,
    "smtpUser": "no-reply@example.com",
    "smtpPassword": "SecurePassword123!",
    "smtpFrom": "no-reply@example.com",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.