Sends an e-mail notification. If a policy containing this action encounters an error, Designer generates the error as the local variable error.do-send-email. For more information about local error variables, see Local Variable Selector.
Consider the following points when creating a policy with <do-send-email> action:
Identity Manager 4.8 and onwards, the engine checks to see if the mail server supports SSL, and if it supports, then it utilizes SSL. Therefore the mail server certificate must be added to the OpenText Identity Manager engine keystore.
Prior to Identity Manager 4.9, the application only supported basic authentication, which required users to provide SMTP server account credentials (user ID and password) to send emails through the mail server. With Identity Manager 4.9 and later versions, users can authenticate to the mail server using either basic or modern authentication methods.
Azure Active Directory uses modern authentication provided by the Office 365 OAuth authentication service. So if you are using Microsoft Outlook on Azure Active Directory as your mail server setup, then you need to register your application with Azure AD first. For more information on how to register your application, see Register an application with the Microsoft identity platform.
When creating a policy with the <do-send-email> action, you must set up a rule to use named passwords in the driver policy. This is because the engine uses the named passwords to read the SMTP server account password and the client secret in order to send email notifications. Each password is accessed via a key, for example, the direxml.engine.smtp key stores the SMTP server account password for basic authentication, while the dirxml.engine.smtp.clientsecret key stores the client secret for modern authentication. Both of these keys are stored in the named passwords at the active driverset level.
(Optional) Specify the User ID in the SMTP system sending the message. Supports variable expansion. For more information, see Variable Selector.
NOTE:The ID field is required for modern authentication. You must specify the email account address that will be used as the originating e-mail address, which is the same as address defined in the from
string name.
Specify the SMTP server address. Supports variable expansion. For more information, see Variable Selector.
Select the e-mail message type.
(Optional) Specify the SMTP server account password.
IMPORTANT:You can store the SMTP server account password as a Named Password on the driver object. This allows the password to be encrypted; otherwise, you enter the password and it is stored in clear text. For more information on Named Passwords, see Securely Storing Driver Passwords with Named Passwords
in the OpenTextâ„¢ Identity Manager CE 24.4 (v4.10) Driver Administration Guide.
Specify the values containing the various e-mail addresses, subject, and message. You can enter the strings manually, or select the Edit the strings icon
to open the Named String Builder and specify the strings. For more information about the Named String Builder, see Named String Builder.
The Send Email action supports the following string arguments:
|
String Name |
Description |
|---|---|
|
The following string arguments are applicable if the mail server is set for either basic or modern authentication: |
|
|
bcc |
Adds the address to the list of BCC e-mail recipients; multiple instances are allowed. Can contain a comma-separated list of recipients. |
|
cc |
Adds the address to the list of CC e-mail recipients; multiple instances are allowed. Can contain a comma-separated list of recipients. |
|
custom-smtp-header |
Specifies a custom SMTP header to add to the e-mail message. |
|
encoding |
Specifies the character encoding to use for the e-mail message. |
|
from |
Specifies the address to be used as the originating e-mail address. |
|
message |
Specifies the content of the e-mail message. |
|
reply-to |
Specifies the address to be used as the e-mail message reply address. |
|
subject |
Specifies the e-mail subject. |
|
to |
Adds the address to the list of e-mail recipients; multiple instances are allowed. Can contain a comma-separated list of recipients. |
|
The following string arguments are only applicable if the mail server is set for modern authentication: |
|
|
tenant-id |
Specifies the Global Unique Identifier (GUID) for your registered account on Azure Active Directory. Also referred to as the Tenant (Directory) ID. Use the Azure portal to obtain the value. |
|
client-id |
Specifies the unique ID assigned by Azure Active Directory to your application. Also referred to as the Application (client) ID. Use the Azure portal to obtain the value. |
|
client-secret |
Specifies a secret string that the application uses to prove its identity when requesting an access token. This encrypted value is unique for your application. Use the Azure portal to obtain the value. |
|
oauth-scope |
Specifies the resource for which the token is granted during token redemption. It defines what the application can access on behalf of the user. It should be https://outlook.office365.com/.default for SMTP. The access token issued to the application is limited to the scope granted. |
|
grant-type |
Used by the application to obtain an access token to access its own resources, not on behalf of a user. It is set to client_credentials by default and should not be modified. |
|
requestURL |
Specifies the request URI of the SMTP server, to which the application sends authentication requests containing client secret, scope, grant type, and auth mechanism in the payload. For example, https://login.microsoftonline.com/{tenantID}/oauth2/v2.0/token |
|
auth-mechanism |
Specifies the format to use to encode and transmit the access token to the SMTP server. The access token authenticates the user's Outlook account. It is set to XOAUTH2 by default and should not be modified. |