- URL:
- https://<root>/system/emailSettings/test
- Methods:
POST- Required Capability:
- Access allowed with the "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 (mail).
Request parameters
| Parameter | Details |
|---|---|
| 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 Example |
| The response format. The default format is Values: |
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
}