listmonk unofficial
POST/settings/smtp/test

Test SMTP settings

Tests SMTP settings using the supplied SMTP configuration values. Provide any settings to test in the request body; all listed fields are optional.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

17 body fields

Optional SMTP settings values to use for the test. All listed fields are optional.

uuidstringoptional
The identifier of the SMTP configuration.
enabledbooleanoptional
Whether the SMTP configuration is enabled.
hoststringoptional
The SMTP server hostname.
hello_hostnamestringoptional
The hostname used in the SMTP HELO or EHLO command.
portintegeroptional
The SMTP server port.
auth_protocolstringoptional
The SMTP authentication protocol.
usernamestringoptional
The username used for SMTP authentication.
email_headersarray<object>optional
Email headers to include, represented as an array of objects.
max_connsintegeroptional
The maximum number of SMTP connections.
max_msg_retriesintegeroptional
The maximum number of message retries.
idle_timeoutstringoptional
The SMTP connection idle timeout.
wait_timeoutstringoptional
The SMTP connection wait timeout.
tls_typestringoptional
The TLS configuration type.
tls_skip_verifybooleanoptional
Whether to skip TLS certificate verification.
strEmailHeadersstringoptional
Email headers represented as a string.
passwordstringoptional
emailstringoptional

1 status code
200Returns a boolean `data` value indicating the SMTP test result.
databooleanoptional

Error handling

Each supplied field must match its declared type: enabled and tls_skip_verify are booleans, port and the connection and retry limits are integers, and email_headers is an array of objects.