Skip To Content
ArcGIS Developers
Dashboard

Update Email Settings

Description

This operation allows you to configure email settings for your organization. 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

ParameterDetails
smtpServer

The IP address, or the fully qualified domain name (FDQN), of the SMTP Server.

Example

smtpServer=smtp.myorg.org
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

fromEmailAddress=admin@myorg.org
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

fromEmailAddressLabel=My Org Admin
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

username=smtpadmin
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

password=test1234
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

smtpPort=25
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

Below is a sample POST request for update that demonstrates how to setup your 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=pjson

Below is a sample POST request for update that demonstrates how to setup your 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=pjson

JSON Response example

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