- URL:https://<root>/system/emailSettings/test(POST only)
- Required Capability:Default administrator role | Security and infrastructure privilege
- Version Introduced:10.8.1
Description
The test operation sends a test email via the SMTP server to ensure that the organization's email settings have been properly configured. If the settings were configured successfully, an email will be sent out to a specified email address (mailTo).
Request parameters
| Parameter | Details |
|---|---|
| mailTo | The email the test message will be sent to. The default value for this parameter will be the email address that has been assigned to fromEmailAddress, set through the Update operation. |
| f | The response format. The default format is html. Values: html | json | pjson |
Example usage
The following is a sample POST request for the test operation:
POST /webadaptor/portaladmin/system/emailSettings/test HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
mailTo=admin@myorg.com&f=pjsonJSON Response example
{
"status": "success",
"recheckAfterSeconds": 10
}