- URL:https://<root>/system/emailSettings/update(POST only)
- Required Capability:Default administrator role | Security and infrastructure privilege
- Version Introduced: 10.8.1
Description
The update operation configures an organization's email settings. These settings will be used to send out email notifications from ArcGIS Enterprise portal regarding password policy updates and license expirations. Email notifications will be sent to your administrative contacts.
Request parameters
| Parameter | Details |
|---|---|
| smtpServer | The IP address, or the fully qualified domain name (FDQN), of the SMTP Server. Example |
| fromEmailAddress | The email address that will be used to send emails from the ArcGIS Enterprise portal. It is recommended that the user associated with this email address is listed under the Administrative Contacts for your organization. Example |
| fromEmailAddressLabel | The label, or person, associated with the fromEmailAddress. This information will be displayed as the sender in the From line for all email notifications. Example |
| authRequired | Specifies if authentication is required (true) to connect with SMTP server specified above. At 10.8.1, only basic authentication (username and password) is supported. The default is false. Values: true | false |
| username | If authRequired is true, this specifies the username of a user who is authorized to access the SMTP server. This field will be unable to be defined if authRequired is false. Example |
| password | If authRequired is true, this specifies the password associated the authorized user specified above. This field will be unable to be defined if authRequired is false. Example |
| smtpPort | The port the SMTP Server will communicate over. Some of the most common communication ports are 25, 465, and 587. The default value is 25. Example |
| encryptionMethod | The encryption method for email messages sent from ArcGIS Enterprise portal. Values: SSL | TLS | NONE |
| f | The response format. The default format is html. Values: html | json | pjson |
Example usage
The following is a sample POST request for the update operation that demonstrates configuring email settings without authentication:
POST /webadaptor/portaladmin/system/emailSettings/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
smtpServer=smtp.myorg.org&fromEmailAddress=admin@myorg.org&fromEmailAddressLabel=My Org Admin&authRequired=false&smtpPort=25&encryptionMethod=NONE&f=pjsonThe following is a sample POST request for the update operation that demonstrates configuring email settings with authentication:
POST /webadaptor/portaladmin/system/emailSettings/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
smtpServer=smtp.myorg.org&fromEmailAddress=admin@myorg.org&fromEmailAddressLabel=My Org Admin&authRequired=true&username=smtpadmin&password=test1234&smtpPort=25&encryptionMethod=NONE&f=pjsonJSON Response example
{
"status": "success",
"recheckAfterSeconds": 10
}