Skip To Content ArcGIS for Developers Sign In Dashboard

Email Settings

Description

This resource returns the email settings that have been configured for your organization. These settings can be used to send out email notifications from ArcGIS Enterprise portal about password policy updates and user type, add-on, or organization capability license expirations. These email notifications will be sent to members listed under your Administrative Contacts.

Note:

Email notifications regarding license expiration will be sent out at an interval of 90 days, 60 days, 30 days, 3 days, 2 days, and 1 day before the licenses expire.

Configuring the email settings for your organization also allows members (with built-in accounts) to use an email-based workflow to retrieve forgotten passwords.

Request parameters

ParameterDetails
f

The response format. The default format is html.

Values: html | json | pjson

Example usage

Below is a sample request URL used to access the emailSettings resource:

https://machine.domain.com/webadaptor/portaladmin/system/emailSettings?f=pjson

JSON Response syntax

{
  "accountId": "<Organization ID>",
  "smtpHost": "<Host information>",
  "smtpPort": <Port number>,
  "mailFrom": "<Admin email address>",
  "mailFromLabel": "<Admin email address apperance>",
  "encryptionMethod": "<SSL | TLS | NONE>",
  "authRequired": <true | false>,
  "smtpUser": "<username for smtp account>", //Only required if authRequired is set to true
  "smtpPass": "<password for smtp account>" //Only required if authRequired is set to true
}

JSON Response example

Without authentication

{
  "accountId": "0123456789ABCDEF",
  "smtpHost": "smtp.myorg.org",
  "smtpPort": 25,
  "mailFrom": "admin@myorg.org",
  "mailFromLabel": "My Org Admin",
  "encryptionMethod": "NONE",
  "authRequired": false
}

With authentication

{
  "accountId": "0123456789ABCDEF",
  "smtpHost": "smtp.myorg.org",
  "smtpPort": 25,
  "mailFrom": "admin@myorg.org",
  "mailFromLabel": "My Org Admin",
  "encryptionMethod": "NONE",
  "authRequired": true,
  "smtpUser": "admin",
  "smtpPass": "test1234"
}