Skip To Content
ArcGIS Developers
Dashboard

Test Email Settings

Description

This operation can be used once the email settings have been configured using the Update operation to send a test email via the SMTP server to ensure that the organization's email settings have been properly configured. If successful, an email will be sent out to the 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.

mailTo=admin@myorg.com
f

The response format. The default format is html.

Values: html | json | pjson

Example usage

Below is a sample POST request for test:

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=html

JSON Response example

{
  "status": "success",
  "recheckAfterSeconds": 10
}