Test

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 (mailTo).

Request parameters

ParameterDetails

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.

Example
Use dark colors for code blocksCopy
1
mailTo=admin@myorg.com

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:

Use dark colors for code blocksCopy
1
2
3
4
5
6
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=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
{
  "status": "success",
  "recheckAfterSeconds": 10
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.