This documentation is for WSO2 Identity Server 5.3.0 . View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

The WSO2 Identity Server (WSO2 IS) provides the means of customizing automated emails sent to the user. This is particularly useful in the case of tenant users as they can customize their emails specifically for users configured under the tenant. Furthermore, tenants do not have access to underlying configuration files, therefore, this customization is now possible directly through the management console.

Editing a template

  1. Log in to the WSO2 Identity Server management console.
  2. Navigate to the Main tab and click List under Email Templates
  3. Select the Template Type, Template Language (locale) and Content Type.

  4. Update the template contents (i.e., Subject, Email Body and Email Footer).

    Placeholders and Custom Claim Dialects

    Tip: You can set different placeholders in order to populate custom information such as {first-name} and {user-id} in the subject, body and footer of the email template.

    You can also specify any custom claim URI created in the WSO2 claim dialect:

    • If it an identity claim, specify the claim as seen in the example below.

      The claim should be specified as {{user.claim.identity.homeAddress}}

    • If it is a normal claim, specify the claim as seen in the example below.

      The claim should be specified as{{user.claim.homeAddress}}.

    Before sending the email, the WSO2 IS will retrieve the user details from the user store configured for this tenant and replace the placeholders with the corresponding values of the user.

  5. Click Save to update.

Note: Ensure that you do not use the "|" character in your Subject , Email Body or Email Footer as this is not supported.

Updating the locale of a user

Once you have set the template language for the user, it is also necessary to specify the locale for the user. Do the following steps to configure this.

  1. Click on List under Claims and select
  2. Select the Locality claim and click Edit. Select the Supported by Default checkbox and click Update
  3. Logout as admin and login as a user with user profile management permissions. 
  4. Click on List under Users and Roles and then select Users
  5. Click on the User Profile button corresponding to the logged in user. 
  6. Enter the locale code for the Locality field and click Update

    Tip: For example, use fr_fr for the French locale, pt_br for Brazil locale and it_it for the Italian locale. This is the format used for country locales in the Identity Server. For more information on country locales, see here.

Now that this is done, any email notifications you receive will be in the language you specified.

Related Links
  • No labels