Custom mail templates for notifications
For more information about creating and editing mail template, see the One Identity Manager Operational Guide.
A mail template consists of general main data such as target format, importance, or mail notification confidentiality, and one or more mail definitions. Mail text is defined in several languages in the mail template. This ensures that the language of the recipient is taken into account when the email is generated.
Creating and editing attestation mail templates
To create and edit mail templates
-
In the Manager, select the Attestation > Basic configuration data > Mail templates category.
This shows all the mail templates that can be used for attestation cases in the result list.
-
Select a mail template in the result list and run the Change main data task.
- OR -
Click in the result list.
This opens the mail template editor.
-
Edit the mail template.
- Save the changes.
Detailed information about this topic
General properties of a mail template
The following general properties are displayed for a mail template:
Table 13: Mail template properties
Mail template |
Name of the mail template. This name will be used to display the mail templates in the administration tools and in the Web Portal. Translate the given text using the button. |
Base object |
Mail template base object. A base object only needs to be entered if the mail definition properties of the base object are referenced.
Use the AttestationCase or AttestationHelper base object for notifications about attestation. |
Report (parameter set) |
Report, made available through the mail template. |
Description |
Mail template description. Translate the given text using the button. |
Target format |
Format in which to generate email notification. Permitted values are:
-
HTML: The email notification is formatted in HTML. Text formats, for example, different fonts, colored fonts, or other text formatting, can be included in HTML format.
-
TXT: The email notification is formatted as text. Text format does not support bold, italics, or colored font, or other text formatting. Images displayed directly in the message are not supported. |
Design type |
Design in which to generate the email notification. Permitted values are:
-
Mail template: The generated email notification contains the mail body in accordance with the mail definition.
-
Report: The generated email notification contains the report specified under Report (parameter set) as its mail body.
-
Mail template, report in attachment: The generated email notification contains the mail body in accordance with the mail definition. The report specified under Report (parameter set) is attached to the notification as a PDF file. |
Importance |
Importance for the email notification. Permitted values are Low, Normal, and High. |
Confidentiality |
Confidentiality for the email notification. Permitted values are Normal, Personal, Private, and Confidential. |
Can unsubscribe |
Specifies whether the recipient can unsubscribe email notification. If this option is set, the emails can be unsubscribed through the Web Portal. |
Deactivated |
Specifies whether this mail template is disabled. |
Mail definition |
Selects the mail definition in a specific language.
NOTE: If the Common | MailNotification | DefaultCulture configuration parameter is set, the mail definition is loaded in the default language for email notifications when the template is opened. |
Language |
Language that applies to the mail template. The recipient's language preferences are taken into account when an email notification is generated. |
Subject |
Subject of the email message. |
Mail body |
Content of the email message. |
Creating and editing a mail definition
Mail texts can be defined in these different languages in a mail template. This ensures that the language of the recipient is taken into account when the email is generated.
To create a new mail definition
-
In the Manager, select the Attestation > Basic configuration data > Mail templates category.
This shows all the mail templates that can be used for attestation cases in the result list.
-
Select a mail template in the result list and run the Change main data task.
-
In the result list, select the language for the mail definition in the Language menu.
All active languages are shown. To use another language, in the Designer, enable the corresponding countries. For more information, see the One Identity Manager Configuration Guide.
-
Enter the subject in Subject.
-
Edit the mail text in the Mail definition view with the help of the Mail Text Editor.
- Save the changes.
To edit an existing mail definition
-
In the Manager, select the Attestation > Basic configuration data > Mail templates category.
This shows all the mail templates that can be used for attestation cases in the result list.
-
Select a mail template in the result list and run the Change main data task.
-
In the Mail definition menu, select the language for the mail definition.
NOTE: If the Common | MailNotification | DefaultCulture configuration parameter is set, the mail definition is loaded in the default language for email notifications when the template is opened.
-
Edit the mail subject line and the body text.
- Save the changes.