Validate IMAP

POST/web/v1/notification/email/validate/imapWEB

Validates an IMAP 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

Name	Type	Required	In	Description
requestId	string	Yes	query	Unique request ID for idempotency/tracking

Request Body

EmailValidationRequest:

Name	Type	Required	In	Description
channelHost	string	Yes	body	Notification channel host/access endpoint
config	object	Yes	body	Email channel configuration to validate
config.username	string	Yes	body	IMAP authentication username
config.password	string	Yes	body	IMAP authentication password
config.imapHost	string	Yes	body	IMAP server hostname
config.imapPort	integer	Yes	body	IMAP server port (1-65535)
config.useSsl	boolean	No	body	Use SSL (default: true)
config.connectionTimeout	integer	No	body	Connection timeout in ms (default: 10000)
config.readTimeout	integer	No	body	Read timeout in ms (default: 30000)

Success Response

Success200

{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "valid": true,
    "results": {
      "IMAP": {
        "success": true,
        "serverHost": "imap.example.com",
        "serverPort": 993,
        "connectionTimeMs": 312,
        "errorCode": null,
        "errorMessage": null
      }
    }
  }
}

Error Responses

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

Notes

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