Multilanguage emails

The language customization feature allows users to change the language emails via OpenIAM, ensuring that they are delivered in the preferred language to enhance user experience by providing clear and accessible information. To configure the feature, use the steps below.

Adding the custom language script to a mail template

1. Open groovy manager and add custom language handler for a mail template, as shown below. Note: This script is defined for the mail template individually.

2. Open Mail template editor from webconsole > Administration > Mail template editor.

3. Add the saved groovy path to a mail template, setting it to the Email Customization Script field.

Notes:

• Please refer the example script defined in this path: /mail/custom/content/CreateUserRequestApproversApprovedEmail.groovy. You can define any attribute for preferred language, and it will be custom to the user.
• Ensure that the user includes the PREFERRED_LANGUAGE attribute. This attribute determines which language to use for the email. If the PREFERRED_LANGUAGE is not set or not found, the default template is used.

Adding a new language to the script

To add more languages to the CreateUserRequestApproversApprovedEmail script, follow the steps below.

1. Identify the Language Code. Each language should be identified by its local code and should be referred from Administration > Languages (e.g., fr for French, es for Spanish, etc.).

Ensure that you follow the correct format for locale codes: [language].

2. Add the Language Translations.

• For each new language, add a new entry in the translations map.
• Each entry should include:
  • Subject: A closure that generates the email subject.
  • Body: A closure that generates the email body with placeholders for dynamic content.

Example

Adding French (fr) and Spanish (es)

Below, you can find the examples of how you can add translations for French and Spanish to the existing translations map.

private static final LinkedHashMap<String, LinkedHashMap<String, Closure<String>>>
translations = new LinkedHashMap<String, LinkedHashMap<String, Closure<String>>>([
// Existing English (en)
"en": new LinkedHashMap<String, Closure<String>>([
"subject": { String name -> "New user activation reminder" },
"body": { Map params ->
"""Dear ${params.firstName} ${params.lastName},
We would like to inform you that the following request has been approved:
Request Type: ${params.requestReason}
Approved by: ${params.requestor}
For: ${params.targetUser}
A new user account has been created for ${params.targetUser}. You will receive
an activation link in a separate email.
Request Number: ${params.requestId}
Access has been requested for the following items: ${params.entitlements}
Reason for request: ${params.reason}
"""
}
]),
// Existing German (gb)
"gb": new LinkedHashMap<String, Closure<String>>([
"subject": { String name -> "Erinnerung an die Aktivierung eines neuen Benutzers"
},
"body": { Map params ->
"""Sehr geehrte/r ${params.firstName} ${params.lastName},
Wir möchten Sie darüber informieren, dass die folgende Anfrage genehmigt
wurde:
Anfragetyp: ${params.requestReason}
Genehmigt von: ${params.requestor}
Für: ${params.targetUser}
Ein neues Benutzerkonto wurde für ${params.targetUser} erstellt. Sie erhalten
einen Aktivierungslink in einer separaten E-Mail.
Anfrage Nummer: ${params.requestId}
Zugriff wurde für folgende Elemente angefordert: ${params.entitlements}
Grund für die Anfrage: ${params.reason}
"""
}
]),
// New French (fr)
"fr": new LinkedHashMap<String, Closure<String>>([
"subject": { String name -> "Rappel d'activation d'un nouvel utilisateur" },
"body": { Map params ->
"""Cher/Chère ${params.firstName} ${params.lastName},
Nous vous informons que la demande suivante a été approuvée :
Type de demande : ${params.requestReason}
Approuvé par : ${params.requestor}
Pour : ${params.targetUser}
Un nouveau compte utilisateur a été créé pour ${params.targetUser}. Vous
recevrez un lien d'activation dans un e-mail séparé.
Numéro de demande : ${params.requestId}
L'accès a été demandé pour les éléments suivants : ${params.entitlements}
Raison de la demande : ${params.reason}
"""
}
]),
// New Spanish (es)
"es": new LinkedHashMap<String, Closure<String>>([
"subject": { String name -> "Recordatorio de activación de un nuevo usuario" },
"body": { Map params ->
"""Estimado/a ${params.firstName} ${params.lastName},
Queremos informarle que la siguiente solicitud ha sido aprobada:
Tipo de solicitud: ${params.requestReason}
Aprobado por: ${params.requestor}
Para: ${params.targetUser}
Se ha creado una nueva cuenta de usuario para ${params.targetUser}. Recibirá
un enlace de activación en un correo electrónico separado.
Número de solicitud: ${params.requestId}
Se ha solicitado acceso a los siguientes elementos: ${params.entitlements}
Motivo de la solicitud: ${params.reason}
"""
}
])
])