Manage email providers using the admin console
You can configure a custom SMTP provider or Microsoft Graph external email service in the Advanced Identity Cloud admin console.
Learn more about email providers in Email provider.
Configure a custom SMTP provider
-
In the Advanced Identity Cloud admin console, go to Integrations > Email Provider.
-
If an external email provider is already configured, click Switch to Built-in Provider to revert to the built-in SMTP server, and then click Confirm.
-
On the Email Provider page, click Custom Provider.
-
In the Add a Custom Email Provider modal, click Custom Provider, and then click Next.
-
Enter details in the following fields:
From Address
Email address of the organization or individual sending the email.
Example:
mycompany@example.com.You can also set this field to an ESV placeholder instead of a literal email address by clicking the token icon () to select an ESV value. When an ESV is set, the field becomes read-only and the From Name field is disabled.
From Name
Name of sending organization.
Host
Hostname or IP address of your SMTP server.
Port
Port number of your SMTP server.
Many SMTP servers require the use of a secure port such as 465 or 587.
Typically, use port 587 with STARTTLS or port 465 with implicit SSL/TLS. Many ISPs flag email from port 25 as spam.
Username
Username for your SMTP server account.
Password
Password for your SMTP server account.
-
Click Show advanced settings, and edit the options and fields:
Socket Connection Timeout (ms)
Elapsed time before Advanced Identity Cloud times out due to unsuccessful socket connection to the SMTP server. A setting of
0disables this timeout.The default is
300000ms (5 minutes).Socket Write Timeout (ms)
Elapsed time before Advanced Identity Cloud times out because the client can’t write to the SMTP server. A setting of
0disables this timeout.The default is
300000(5 minutes).Socket Timeout (ms)
Elapsed time before Advanced Identity Cloud times out due to inactivity. A setting of
0disables this timeout.The default is
300000(5 minutes).Use STARTTLS
-
If enabled, and if the SMTP server supports the STARTTLS command, then Advanced Identity Cloud switches to a TLS-protected connection before issuing any login commands.
-
If the SMTP server does not support STARTTLS, the connection continues without the use of TLS.
Enabled by default.
Use SSL
If enabled, Advanced Identity Cloud uses SSL to connect to the SMTP server.
Disabled by default.
Allow UTF-8
If enabled, adds support for UTF-8 (Non-ASCII) characters in the local part of email addresses (everything before the
@character).Disabled by default.
Do not set this property unless your SMTP provider supports UTF-8 characters. Learn more in International email addresses.
-
-
Click Save.
Configure a Microsoft Graph email provider
-
In the Advanced Identity Cloud admin console, go to Integrations > Email Provider.
-
If an external email provider is already configured, click Switch to Built-in Provider to revert to the built-in SMTP server, and then click Confirm.
-
On the Email Provider page, click Custom Provider.
-
In the Add a Custom Email Provider modal, click Microsoft Graph, and then click Next.
-
Enter details in the following fields:
From Address
Email address of the organization or individual sending the email.
Example:
mycompany@example.com.You can also set this field to an ESV placeholder instead of a literal email address by clicking the token icon () to select an ESV value. When an ESV is set, the field becomes read-only and the From Name field is disabled.
From Name
Name of sending organization.
Mail Endpoint
The URI for the Microsoft Graph
sendMailendpoint.Typical format:
https://graph.microsoft.com/v1.0/users/{user}@{tenant}.onmicrosoft.com/sendMailClient ID
Client ID used to request an access token from the token endpoint. This is obtained during Azure application creation.
Client Secret Identifier
Client secret used to request an access token from the token endpoint. This is obtained during Azure application creation.
Token Endpoint
OAuth 2.0 token endpoint.
Typical format:
https://login.microsoftonline.com/{tenant}.onmicrosoft.com/oauth2/v2.0/token -
Click Show advanced settings, and edit the options and fields:
Socket Connection Timeout (ms)
Elapsed time before Advanced Identity Cloud times out due to unsuccessful socket connection to the server. A setting of
0disables this timeout.The default is
300000ms (5 minutes).Thread Pool Size
Emails are sent in separate threads managed by a thread pool. This property sets the number of concurrent emails that can be handled at a specific time. The default thread pool size (if none is specified) is
20.Scope
The OAuth 2.0 scopes to request when Advanced Identity Cloud obtains an access token from the token endpoint. Enter the scopes as a JSON array of strings.
The default value is:
https://graph.microsoft.com/.defaultThis requests all application permissions granted to the app registration in your Microsoft Azure tenant. You don’t normally need to change this value.
Scope Delimiter
Scope delimiter to use. Defaults to space.
-
Click Save.
Update the email provider configuration
-
In the Advanced Identity Cloud admin console, go to Integrations > Email Provider.
-
On the Email Provider page, click Edit.
-
Update the details.
For security reasons, password and secret fields are not pre-populated. Leave these fields blank unless you need to change the existing credentials.
-
Click Save.
Revert to the built-in provider
If you need to revert the email provider to use the built-in SMTP server:
-
In the Advanced Identity Cloud admin console, go to Integrations > Email Provider.
-
On the Email Provider page, click Switch to Built-in Provider.
-
Click Confirm.
|
The built-in SMTP server is for testing purposes only and has the limitations noted at the top of this page. |