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.

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

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

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.

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.

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

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.

This property is a notification text when the new user addition requires approval.

Recipient: main user.
Available variables:

• invitee: "<firstname> <surname>" of the user that requires the approval

• inviteeUser.<attribute name>: Any attribute the invitee has.

• inviteeUser.pendingUserID: The invitee pending user id.

• inviteeUser.org.friendlyName: The friendly name of the organization where the user is stored to.

• inviteeUser.org.entityName: The entity name of the organization where the user is stored to.

• inviteeUser.org.technicalName: The technical name of the organization where the user is stored to.

• organization: The friendly name of the organization where the user is stored to.

• link: Link to the person approval form.

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

Recipient: main user.
Available variables:

• invitee: "<firstname> <surname>" of the user that requires approval.

• inviteeUser.<attribute name>: Any attribute the invitee has.

• inviteeUser.pendingUserID: The invitee pending user id.

• inviteeUser.org.friendlyName: The friendly name of the organization where the user is stored to.

• inviteeUser.org.entityName: The entity name of the organization where the user is stored to.

• inviteeUser.org.technicalName: The technical name of the organization where the user is stored to.

• organization: The friendly name of the organization where the user is stored to.

• link: Link to the person approval form.

This property is a notification text for the new user that the main user has approved the new user.

Recipient: new user.
Available variables:

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

• organization: The friendly name of the organization where the user is stored to.

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

• recipientUser.org.friendlyName: The friendly name of the organization where the user is stored to.

• recipientUser.org.entityName: The entity name of the organization where the user is stored to.

• recipientUser.org.technicalName: The technical name of the organization where the user is stored to.

• link: Link to the self-service user interface.

This property is a notification text for the new user that the main user has approved the new user, but a password reset is mandatory.

Recipient: new user.
Available variables:

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

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

• recipientUser.org.friendlyName: The friendly name of the organization where the user is stored to.

• recipientUser.org.entityName: The entity name of the organization where the user is stored to.

• recipientUser.org.technicalName: The technical name of the organization where the user is stored to.

• link: Link to the password reset page.

This property is a notification for the inviter that the invited user has registered. This message is not sent if there is an approval required for the registration.

Recipient: inviter of the user.
Available variables:

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

• recipientUser.<attribute name>: Any attribute the inviter has.

• recipientUser.org.friendlyName: The friendly name of the recipient's organization.

• recipientUser.org.entityName: The entity name of the recipient's organization.

• recipientUser.org.technicalName: The technical name of the recipient's organization.

• invitee: "<firstname> <surname>" of the user that has been invited.

• inviteeUser.<attribute name>: Any attribute the invitee has.

• organization: The organization where the invited user is stored to.

• inviteeUser.org.friendlyName: The friendly name of the organization where the invited user is stored to.

• inviteeUser.org.entityName: The entity name of the organization where the invited user is stored to.

• inviteeUser.org.technicalName: The technical name of the organization where the invited user is stored to.

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

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

This property is a notification for the inviter that the main user has approved the new user. This message is not sent if there is no approval required for the registration.

Recipient: inviter of the user.
Available variables:

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

• recipientUser.<attribute name>: Any attribute the inviter has.

• recipientUser.org.friendlyName: The friendly name of the recipient's organization.

• recipientUser.org.entityName: The entity name of the recipient's organization.

• recipientUser.org.technicalName: The technical name of the recipient's organization.

• invitee: "<firstname> <surname>" of the user that has been invited.

• inviteeUser.<attribute name>: Any attribute the invitee has.

• organization: The organization where the invited user is stored to.

• inviteeUser.org.friendlyName: The friendly name of the organization where the invited user is stored to.

• inviteeUser.org.entityName: The entity name of the organization where the invited user is stored to.

• inviteeUser.org.technicalName: The technical name of the organization where the invited user is stored to.

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

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

This property is a notification text for the mandater that the main user has approved the new user with a mandate.

Recipient: mandater.
Available variables:

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

• recipientUser.<attribute name>: Any attribute the recipient has.

• recipientUser.org.friendlyName: The friendly name of the recipient's organization.

• recipientUser.org.entityName: The entity name of the recipient's organization.

• recipientUser.org.technicalName: The technical name of the recipient's organization.

• invitee: "<firstname> <surname>" of the user that has been invited.

• inviteeUser.<attribute name>: Any attribute the invitee has.

• organization: The organization where the invited user is stored to.

• inviteeUser.org.friendlyName: The friendly name of the organization where the invited user is stored to.

• inviteeUser.org.entityName: The entity name of the organization where the invited user is stored to.

• inviteeUser.org.technicalName: The technical name of the organization where the invited user is stored to.

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

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

This property is a notification for the new user that the main user has rejected the new user.

Recipient: denied user.
Available variables:

• recipient: "<firstname> <surname>" of the denied user.

• organization: The organization where the user would have been stored

• message: Message given by the rejecter.

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

This property is a notification text for the inviter that the new user has rejected the invitation.

Recipient: inviter.
Available variables:

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

• recipientUser.<attribute name>: any attribute the inviter has.

• invitee: "<firstname> <surname>" of the denied invitee.

• inviteeUser.<attribute name>: any attribute the denied invitee has.

• organization: The organization of the denied invitee.

• message: Message given by the rejecter.

This property is a notification text for the inviter that the new user has rejected the invitation.

Recipient: inviter.
Available variables:

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

• recipientUser.<attribute name>: any attribute the inviter has.

• invitee: "<firstname> <surname>" of the denied invitee.

• inviteeUser.<attribute name>: any attribute the denied invitee has.

• organization: The organization of the denied invitee.

• roles_<locale>: List of the relative names of the roles the denied invitee had been invited to.

• rolesFull_<locale>: List of the full names of the roles the denied invitee had been invited to.

• message: Message given by the rejecter.

This property is a notification text for the inviter that the main user has rejected the new user.

Recipient: inviter.
Available variables:

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

• recipientUser.<attribute name>: any attribute the inviter has.

• invitee: "<firstname> <surname>" of the denied invitee.

• inviteeUser.<attribute name>: Any attribute the denied invitee has.

• organization: The organization of the denied invitee.

• message: Message given by the rejecter.

This property is a notification text for the inviter that the main user has rejected the new user.

Recipient: inviter.
Available variables:

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

• recipientUser.<attribute name>: any attribute the inviter has.

• invitee: "<firstname> <surname>" of the denied invitee.

• inviteeUser.<attribute name>: Any attribute the denied invitee has.

• organization: The organization of the denied invitee.

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

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

• message: Message given by the rejecter.

This property is a notification text to the invited user for an expired user invitation.

Recipient: expired user.
Available variables:

• recipient: "<firstname> <surname>" of the expired user.

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

• user.pendingUserID: the pending user id.

• user.org.friendlyName: The friendly name of the recipient's organization.

• user.org.entityName: The entity name of the recipient's organization.

• user.org.technicalName: The technical name of the recipient's organization.

This property is a notification text to the inviter for an expired user invitation.

Recipient: inviter.
Available variables:

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

• recipientUser.<attribute name>: Any attribute the inviter has.

• invitee: "<firstname> <surname>" of the expired user.