Email text localization - CustomerID

Email text localization - CustomerID

mailmessages.properties configuration file contains email texts for localization. You can also add language specific mailmessages_XX.properties configuration files in addition to the multilanguage file. Language specific email messages are sent when we can ascertain the desired language based on the locale attribute of the user receiving the email message. The multilanguage emails are used when we don't know the locale preference of the receiving user.

Example configuration files can be found as a starting point in the file customerid\tools\examples\custom\mailmessages.properties and must be copied to customerid\application\custom\mailmessages.properties to become active.

You can use certain variables in the message texts. The variables might not always have values set for them. Values are set for variables if the system can fill them in. Sometimes the value might not be available. Variables are inserted using the following syntax: ${variable_name}

All emails have three separate property keys that all have the same prefix but a different postfix. The keys are:

  • <prefix>.enabled: This property defines if the specific type of email is sent by the system or not. This property can only be defined in the mailmessages.properties configuration file. It cannot be used in the language specific mailmessages_XX.properties configuration files.

  • <prefix>.subject: This property defines the subject of the email.

  • <prefix>.message: This property defines the message content of the email.

Since Ubisecure CustomerID 4.2.0 many of the messages below can be customized by workflow. This is further documented at the bottom of this page.

Since Ubisecure CustomerID 5.2.2 you may also specify the content of email messages as HTML. See the notification.email.format.html configuration parameter description in Notification properties - CustomerID.

email.pendingUser.creation

This property is a notification text for a new pending user created via a REST call.

Recipient: new pending user.
Available variables:

  • link: Link to the registration.

  • user.<attribute name>: Any attribute the pending user has.

  • user.pendingUserID: the pending user id

email.inviteUser.role

This property is a notification text for a new user invitation.

Recipient: new user.
Available variables:

  • message: The message given by the inviter when making the invitation in the user interface.

  • recipient: "<firstname> <surname>", of the recipient.

  • link: Link to the person registration.

  • sender: "<firstname> <surname>\n<organization name>\n<email>\n<mobile>", of the inviter.

  • roles_<locale> : Relative names of the roles the user has been invited to.

  • rolesFull_<locale>: Full names of the roles the user has been invited to.

  • user.<attribute name>: Any attribute the pending user has.

  • user.pendingUserID: the pending user id

email.inviteUserRenotify.user

This property is a notification text that is displayed when a new user invitation (made via a REST call) is pending for user registration after reminder period has passed.

Recipient: new user.
Available variables:

  • recipient: "<firstname> <surname>", of the recipient.

  • link: Link to the person registration.

  • sender: "<REST inviter email>".

  • user.<attribute name>: Any attribute the pending user has.

  • user.pendingUserID: the pending user id.

email.inviteUserRenotify.role

This property is a notification text that is displayed when a new user invitation is pending for approval after reminder period has passed.

Recipient: new user.
Available variables:

  • message: The message given by the inviter when making the invitation in the user interface.

  • recipient: "<firstname> <surname>", of the recipient.

  • link: Link to the person registration.

  • sender: "<firstname> <surname>\n<organization name>\n<email>\n<mobile>", of the inviter.

  • roles_<locale>: List of the relative names of the roles the user has been invited to.

  • rolesFull_<locale>: List of the full names of the roles the user has been invited to.

  • user.<attribute name>: Any attribute the pending user has.

  • user.pendingUserID: the pending user id.

email.inviteUser.mandate.XXX

This property is a notification text for a new user invitation with a mandate. XXX stands for the type of the mandate:

p2p = person-to-person
p2b = person-to-business
b2p = business-to-person
b2b = business-to-business
For example:  email.inviteUser.mandate.p2p
Recipient: new user.
Available variables:

  • message: The message given by the mandater when making the mandate in the user interface.

  • recipient: "<firstname> <surname>", of the recipient.

  • link: Link to the person registration.

  • sender: "<firstname> <surname>\n<organization name>\n<email>\n<mobile>", of the mandater.

  • inviter: Value depends on the type of the mandate. If the mandate is given by a person then the value is "<firstname> <surname>". If the mandate is given by an organization then the value is "<organization friendly name>".

When the mandate recipient is a person also the following variables are available:

  • recipientUser.<attribute name>: Any attribute the pending user has.

  • recipientUser.pendingUserID: the pending user id

email.inviteUserRenotify.mandate.XXX

This property is a notification text that reminds of a new user invitation with a mandate.

Recipient: new user.
Available variables:

  • message: The message given by the mandater when making the mandate in the user interface.

  • link: Link to the person registration.

  • recipient: "<firstname> <surname>", of the recipient.

  • sender: "<firstname> <surname>\n<organization name>\n<email>\n<mobile>", of the inviter.

When the mandate recipient is a person also the following variables are available:

  • user.<attribute name>: Any attribute the pending user has.

  • user.pendingUserID: the pending user id.