Test email

Test email

post

Check SMTP configurations by sending testing email.

Authorizations

Body

serverstringrequired

SMTP server used for sending mails.

portinteger · int32 · max: 65535required

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

reply_tostringrequired

A Reply-To address is identified by inserting the Reply-To header in your email.
It is the email address that the reply message is sent when you want the reply to go to an email address that is different than the From: address.

usernamestring · max: 128required

Username or email address.

passwordstringrequired

Password for email account.

authstring · enumrequired

The authorization protocols.
Can be either:

• LOGIN: Use LOGIN authorization protocol.
• PLAIN Use PLAIN authorization protocol.

Options: LOGIN, PLAIN

enable_tls_sslboolean · default: truerequired

Whether to enable TLS/SSL.

enable_starttls_autoboolean · default: truerequired

Whether StartTLS is automatically enabled.

subjectstringrequired

Mail subject.

contentstringrequired

Mail content.

recipientsstringrequired

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/test_email' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "server": "text",
    "port": 80,
    "reply_to": "text",
    "username": "text",
    "password": "text",
    "auth": "LOGIN",
    "enable_tls_ssl": true,
    "enable_starttls_auto": true,
    "subject": "text",
    "content": "text",
    "recipients": "text"
  }'

200

4XX

200

No body

OK