Sign in
latestSwagger 2.02026-08-10143234301.7 KB

dc2736850e42

Rest

Sends a test email to the provided address with the given custom settings

post/SmtpSettings/Test

Query parameters

tostring required

The email address to send the message to

Headers

Authorizationstring required

Bearer {user_token}

SiteIdinteger required

Site ID

Request body

Hoststring

The hostname of the subscriber's SMTP server

Usernamestring

Username for the provided SMTP server - This should be a valid email address.

Portinteger

The port used to connect to the specified host - Official SMTP ports per RFC 3207 are 25 for insecure connections and 587 for using the STARTTLS command. Other ports are technically valid but not recommended.

Timeoutinteger

The timeout in milliseconds for requests sent to the specified host

Secureboolean

Whether to use SSL/TLS to secure the connection with the specified host - This option only supports securing the connection via the explicit STARTTLS command which should be performed on port 587. Optional: when omitted on an update the stored value is left as it is, so a caller that does not manage this setting cannot turn TLS off by not mentioning it.

Response

OK

Hoststring

The hostname of the subscriber's SMTP server

Usernamestring

Username for the provided SMTP server - This should be a valid email address.

Portinteger

The port used to connect to the specified host - Official SMTP ports per RFC 3207 are 25 for insecure connections and 587 for using the STARTTLS command. Other ports are technically valid but not recommended.

Timeoutinteger

The timeout in milliseconds for requests sent to the specified host

Secureboolean

Whether to use SSL/TLS to secure the connection with the specified host - This option only supports securing the connection via the explicit STARTTLS command which should be performed on port 587. Optional: when omitted on an update the stored value is left as it is, so a caller that does not manage this setting cannot turn TLS off by not mentioning it.