Test the SMTP settings

GET /api/2.0/smtpsettings/smtp/test

Request

Tests the SMTP settings for the current portal (sends test message to the user email).

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Examples

GET /api/2.0/smtpsettings/smtp/test HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/smtpsettings/smtp/test \
  --header 'Accept: application/json'

Responses

200

SMTP operation status

completedboolean

Specifies if the SMTP operation is completed or not

idstring

SMTP operation ID

errorstring

SMTP operation error

statusstring

SMTP operation status

percentsintegerformat: int32

Percentage of SMTP operation completion

401

Unauthorized

403

Forbidden