HomeGuidesAPI Reference
API Reference

Send test email to verify SMTP configuration

Sends a test email to the specified recipient(s) to verify SMTP server configuration is working correctly. The test email confirms email delivery with a predefined subject and body. If password is omitted but authentication is enabled, the stored SMTP password will be used only if the submitted server, port, and user match the existing configuration. If they do not match, the request is rejected with 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Test email configuration containing recipient address and SMTP server settings.

Request object for sending a test email to verify SMTP configuration. Use 'recipients' for comma-separated email addresses and 'emailInfo' for SMTP settings.

string
required

Email address(es) to send the test email to. Multiple addresses can be comma-separated.

emailInfo
object
required

SMTP server configuration for sending the test email. Server, emailSender, and emailUser (if authentication enabled) are required.

Responses
204

Test email sent successfully. The action is logged in the system audit log.

401

Unauthorized - Valid authentication credentials required with READ_WRITE role.

403

Forbidden - User does not have READ_WRITE permission.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/html