Skip to content

Validate SMTP

POST/web/v1/notification/email/validate/smtpWEB

Validates an SMTP email server configuration by attempting to connect and authenticate.

Authentication

Requires a valid JWT token and Turnstile verification. Gateway validation: enableJwtToken=true, enableTurnstile=true.

Request Parameters

Query Parameters

NameTypeRequiredInDescription
requestIdstringYesqueryUnique request ID for idempotency/tracking

Request Body

EmailValidationRequest:

NameTypeRequiredInDescription
channelHoststringYesbodyNotification channel host/access endpoint
configobjectYesbodyEmail channel configuration to validate
config.smtpHoststringYesbodySMTP server hostname
config.smtpPortintegerYesbodySMTP server port (1-65535)
config.senderEmailstringYesbodySender email address
config.senderNamestringYesbodySender display name
config.usernamestringYesbodySMTP authentication username
config.passwordstringYesbodySMTP authentication password
config.useSslbooleanNobodyUse SSL (default: true)
config.useStartTlsbooleanNobodyUse STARTTLS (default: false)
config.connectionTimeoutintegerNobodyConnection timeout in ms (default: 10000)
config.readTimeoutintegerNobodyRead timeout in ms (default: 30000)

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "valid": true,
    "results": {
      "SMTP": {
        "success": true,
        "serverHost": "smtp.example.com",
        "serverPort": 587,
        "connectionTimeMs": 245,
        "errorCode": null,
        "errorMessage": null
      }
    }
  }
}

Error Responses

CodeDescription
4000Validation error (missing required config fields)
4010Unauthorized (invalid or missing JWT token)
4030Turnstile verification failed

Notes

  • This endpoint tests the SMTP connection only. Use the IMAP validation endpoint to test IMAP connectivity.
  • The requestId query parameter can be used for idempotency and request tracking.
  • A successful validation does not create or modify any channel.

Internal Documentation