Email Settings

URL:
https://<root>/system/emailSettings
Methods:
GET
Operations:
Update, Test, Delete
Required Capability:
Access allowed with the "Security and Infrastructure" privilege
Version Introduced:
10.8.1

Description

The emailSettings resource returns the email settings that have been configured for an 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, and allow members with built-in account to use an email-based workflow to retrieve forgotten passwords. Email notifications regarding policy changes and expiration notices will be sent to members listed under the organization's administrative contacts.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/portaladmin/system/emailSettings?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "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 examples

Example one: no authentication

The example below demonstrates a returned response when no authentication is required:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "accountId": "0123456789ABCDEF",
  "smtpHost": "smtp.myorg.org",
  "smtpPort": 25,
  "mailFrom": "admin@myorg.org",
  "mailFromLabel": "My Org Admin",
  "encryptionMethod": "NONE",
  "authRequired": false
}

Example two: authentication required

The example below demonstrates a returned response when authentication is required. If authRequired is true, the smtp account username and password are also included in the response:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "accountId": "0123456789ABCDEF",
  "smtpHost": "smtp.myorg.org",
  "smtpPort": 25,
  "mailFrom": "admin@myorg.org",
  "mailFromLabel": "My Org Admin",
  "encryptionMethod": "NONE",
  "authRequired": true,
  "smtpUser": "admin",
  "smtpPass": "test1234"
}

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