Page tree
Skip to end of metadata
Go to start of metadata

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.

email.userApprovalRequest

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.

email.userApprovalRequestRenotify

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.

email.userApproval

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.

email.userApprovalResetPassword

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.

email.userRegistrationInviters

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.

email.userApprovalInviters

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.

email.userApprovalMandateInviters

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.

email.userDenial

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.

email.userSelfDenialMandateInviters

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.

email.userSelfDenialRoleInviters

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.

email.userDenialMandateInviters

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.

email.userDenialRoleInviters

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.

email.userExpired

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.

email.userExpiredInviters

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.
  • inviteeUser.<attribute name>: Any attribute the expired user has.
  • organization: The organization of the expired user.
  • roles_<locale>: Relative names of the roles the expired user had been invited to.
  • rolesFull_<locale>: Full names of the roles the expired user had been invited to.

email.roleInvite

This property is a notification text for inviting a user to a new role.

Recipient: invited user.
Available variables:

  • recipient: "<firstname> <surname>" of the invited user.
  • user.<attribute name>: Any attribute the invited user has.
  • user.pendingUserID: The pending user id of the invited user.
  • 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.
  • roles_<locale>: The relative name of the role the user has been invited to.
  • rolesFull_<locale>: The full name of the role the user has been invited to.
  • organization: The organization of the invited user.
  • inviterUser.<attribute name>: Any attribute the inviter has.
  • sender: "<firstname> <surname>\n<organization>\n<email>\n<mobile>" of the inviter.
  • message: The message given by the inviter.
  • link: The link where the user can approve or reject the role.

email.roleInviteRenotify

This property is a notification text for reminding the user on an invitation to a new role.

Recipient: invited user.
Available variables:

  • recipient: "<firstname> <surname>" of the invited user.
  • user.<attribute name>: Any attribute the invited user has.
  • user.pendingUserID: The pending user id of the invited user.
  • 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.
  • roles_<locale>: The relative name of the role the user has been invited to.
  • rolesFull_<locale>: The full name of the role the user has been invited to.
  • organization: The organization of the invited user.
  • inviterUser.<attribute name>: Any attribute the inviter has.
  • sender: "<firstname> <surname>\n<organization>\n<email>\n<mobile>" of the inviter.
  • message: The message provided by the inviter.
  • link: The link where the user can approve or reject the role.

email.roleApprovalRequest

This property is a notification text for the main user that the role invitation requires approval.

Recipient: main user.
Available variables:

  • invitee: "<firstname> <surname>" of the invited user.
  • inviteeUser.<attribute name>: Any attribute the invited user has.
  • organization: The organization of the invited user.
  • roles_<locale>: The relative name of the role the user has been invited to
  • rolesFull_<locale>: The full name of the role the user has been invited to
  • link: Link to the endpoint where the main user can approve or reject the request.

email.roleApprovalRemoveRequest

This property is a notification text for approving a role removal request.

Recipient: main user.
Available variables:

  • invitee: "<firstname> <surname>" of the invited user.
  • inviteeUser.<attribute name> : Any attribute the invited user has.
  • organization: The organization of the invited user.
  • roles_<locale> : The relative name of the role the user has been invited to.
  • rolesFull_<locale> : The full name of the role the user has been invited to.
  • link: Link to the endpoint where the main user can approve or reject the request.

email.roleApprovalRequestRenotify

This property is a notification text for reminding the main user on handling the role invitation.

Recipient: main user.
Available variables:

  • invitee: "<firstname> <surname>" of the invited user.
  • inviteeUser.<attribute name>: Any attribute the invited user has.
  • organization: The organization of the invited user.
  • roles_<locale>: The relative name of the role the user has been invited to.
  • rolesFull_<locale>: The full name of the role the user has been invited to.
  • link: Link to the endpoint where the main user can approve or reject the request.

email.roleInvitationApproved

This property is a notification text for an approved role invitation.

Recipient: inviter.
Available variables:

  • recipient: "<firstname> <surname>" of the inviter.
  • recipientUser.<attribute name>: Any attribute the inviter has.
  • invitee: "<firstname> <surname>" of the invitee
  • roles_<locale>: The relative name of the role the invitee was invited to.
  • rolesFull_<locale>: The full name of the role the invitee was invited to.

email.roleInvitationDenied

This property is a notification text for a rejected role invitation.

Recipient: inviter.
Available variables:

  • recipient: "<firstname> <surname>" of the inviter.
  • recipientUser.<attribute name>: Any attribute the inviter has.
  • invitee: "<firstname> <surname>" of the invitee.
  • roles_<locale>: The relative name of the role the invitee was invited to.
  • rolesFull_<locale>: The full name of the role the invitee was invited to.

email.roleInvitationApproverApproved

This property is a notification text sent to the inviter when the main user has approved the role invitation.

Recipient: inviter.
Available variables:

  • recipient: "<firstname> <surname>" of the inviter.
  • recipientUser.<attribute name>: Any attribute the inviter has.
  • invitee: "<firstname> <surname>" of the invitee.
  • inviteeUser.<attribute name>: Any attribute the invitee has.
  • roles_<locale>: The relative name of the role the invitee was invited to.
  • rolesFull_<locale>: The full name of the role the invitee was invited to.

email.roleInvitationApproverDenied

This property is a notification text sent to the inviter when the main user has rejected the role invitation.

Recipient: inviter.
Available variables:

  • recipient: "<firstname> <surname>" of the inviter.
  • recipientUser.<attribute name>: Any attribute the inviter has.
  • invitee: "<firstname> <surname>" of the invitee.
  • inviteeUser.<attribute name>: Any attribute the invitee has.
  • roles_<locale>: The relative name of the role the invitee was invited to.
  • rolesFull_<locale>: The full name of the role the invitee was invited to.

email.roleRemoveApproverApproved

This property is a notification text sent to the inviter when the main user has approved the role removal.

Recipient: inviter.
Available variables:

  • recipient: "<firstname> <surname>" of the inviter.
  • recipientUser.<attribute name>: Any attribute the inviter has.
  • invitee: "<firstname> <surname>" of the invitee.
  • inviteeUser.<attribute name>: Any attribute the invitee has.
  • roles_<locale>: The relative name of the role that was removed.
  • rolesFull_<locale>: The full name of the role that was removed.

email.roleRemoveApproverDenied

This property is a notification text sent to the inviter when the main user has denied the role removal.

Recipient: inviter.
Available variables:

  • recipient: "<firstname> <surname>" of the inviter.
  • recipientUser.<attribute name>: Any attribute the inviter has.
  • invitee: "<firstname> <surname>" of the invitee.
  • inviteeUser.<attribute name>: Any attribute the invitee has.
  • roles_<locale>: The relative name of the role which removal was denied.
  • rolesFull_<locale>: The full name of the role which removal was denied.

email.roleInvitationExpiredInviter

This property is a notification text for an expired role invitation.

Recipient: inviter.
Available variables:

  • recipient: "<firstname> <surname>" of the inviter.
  • recipientUser.<attribute name>: Any attribute the inviter has.
  • invitee: "<firstname> <surname>" of the invitee.
  • inviteeUser.<attribute name>: Any attribute the invitee has.
  • organization: The organization of the invitee.
  • roles_<locale>: The relative name of the role the invitee was invited to.
  • rolesFull_<locale>: The full name of the role the invitee was invited to.

email.roleInvitationExpiredInvitee

This property is a notification text for an expired role invitation.

Recipient: invited user.
Available variables:

  • recipient: "<firstname> <surname>" of the invited user.
  • recipientUser.<attribute name>: Any attribute the invited user has.
  • roles_<locale>: The relative name of the role the user was invited to.
  • rolesFull_<locale>: The full name of the role the user was invited to.
  • organization: The organization of the invitee.

email.mandateInvite.XXX

This property is a mandate invitation from the inviter to the mandated person. 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.mandateInvite.p2p
Recipient: mandated person.
Available variables:

  • recipient: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandated entity is an organization.
  • inviter: "<firstname> <surname>" if the mandater is a person. The name of the organization if the mandated entity is an organization.
  • inviterUser.<attribute name>: Any attribute of the mandater when the mandater is a person.
  • inviterOrg.friendlyName: The friendly name of the mandater organization when the mandater is an organization.
  • inviterOrg.entityName: The entity name of the mandater organization when the mandater is an organization.
  • inviterOrg.technicalName: The technical name of the mandater organization when the mandater is an organization.
  • sender: "<firstname> <surname>\n<organization>\n<email>\n<mobile>" of the mandater.
  • message: The message given by the mandater.
  • link: Link to the endpoint from which the mandated user can approve or reject the mandate.

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

When the mandate recipient is an organization also the following variables are available:

  • recipientOrg.friendlyName: The friendly name of the mandatee organization when the mandatee is an organization.
  • recipientOrg.entityName: The entity name of the mandatee organization when the mandatee is an organization.
  • recipientOrg.technicalName: The technical name of the mandatee organization when the mandatee is an organization.

email.mandateInviteRenotify.XXX

This property is a notification text for reminding the mandated person on a pending mandate invitation.

Recipient: mandated person.
Available variables:

  • recipient: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandated entity is an organization.
  • inviter: "<firstname> <surname>" if the mandater is a person. The name of the organization if the mandater is an organization.
  • inviterUser.<attribute name>: Any attribute of the mandater when the mandater is a person.
  • inviterOrg.friendlyName: The friendly name of the mandater organization when the mandater is an organization.
  • inviterOrg.entityName: The entity name of the mandater organization when the mandater is an organization.
  • inviterOrg.technicalName: The technical name of the mandater organization if the mandater is an organization.
  • sender: "<firstname> <surname>\n<organization>\n<email>\n<mobile>" of the mandater.
  • message: The message provided by the mandater.
  • link: Link to the endpoint from which the mandated user can approve of reject the mandate.

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

When the mandate recipient is an organization also the following variables are available:

  • recipientOrg.friendlyName: The friendly name of the mandatee organization when the mandatee is an organization.
  • recipientOrg.entityName: The entity name of the mandatee organization when the mandatee is an organization.
  • recipientOrg.technicalName: The technical name of the mandatee organization when the mandatee is an organization.

email.mandateInvitationApproved

This property is a notification text for the mandater upon an approved mandate invitation.

Recipient: mandater.
Available variables:

  • recipient: "<firstname> <surname>" of the mandater.
  • recipientUser.<attribute name>: Any attribute the mandater has.
  • invitee: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandated entity is an organization.
  • inviteeUser.<attribute name>: Any attribute the mandated person has.
  • inviteeOrg.friendlyName: The friendly name of the organization when the mandated entity is an organization.
  • inviteeOrg.entityName: The entity name of the organization when the mandated entity is an organization.
  • inviteeOrg.technicalName: The technical name of the organization when the mandated entity is an organization.

email.mandateInvitationDenied

This property is a notification text for the mandater upon a rejected mandate invitation.

Recipient: mandater.
Available variables:

  • recipient: "<firstname> <surname>" of the mandater.
  • recipientUser.<attribute name>: Any attribute the mandater has.
  • invitee: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandated entity is an organization.
  • inviteeUser.<attribute name>: Any attribute the mandated person has.
  • inviteeOrg.friendlyName: The friendly name of the organization when the mandated entity is an organization.
  • inviteeOrg.entityName: The entity name of the organization when the mandated entity is an organization.
  • inviteeOrg.technicalName: The technical name of the organization when the mandated entity is an organization.

email.mandateInvitationExpiredInviter

This property is a notification text sent upon an expired mandate invitation.

Recipient: mandater.
Available variables:

  • recipient: "<firstname> <surname>" of the mandater.
  • recipientUser.<attribute name>: Any attribute the mandater has.
  • invitee: "<firstname> <surname>" of the mandatee.
  • inviteeUser.<attribute name>: Any attribute the mandatee has.

email.mandateInvitationExpiredInvitee

This property is a notification text sent upon an expired mandate invitation.

Recipient: mandated person.
Available variables:

  • recipient: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandatee is an organization.
  • recipientUser.<attribute name>: Any attribute the mandater has if the mandated entity is a person.
  • recipientOrg.friendlyName: The friendly name of the organization when the mandated entity is an organization.
  • recipientOrg.entityName: The entity name of the organization when the mandated entity is an organization.
  • recipientOrg.technicalName: The technical name of the organization when the mandated entity is an organization.
  • inviter: "<firstname> <surname>" of the mandater.

email.mandateRemovedPerson.inviter

This property is a notification text sent to a person when a mandate is removed.

Recipient: mandater person.
Available variables:

  • recipient: The name of the person receiving the notification.
  • invitee: "<firstname> <surname>" if the mandated entity is a person. The name of the organization of the mandated entity is an organization.
  • inviteeUser.<attribute name>: Any attribute the user has if the mandated entity is a person.
  • inviter: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandated entity is an organization.

email.mandateRemovedPerson.invitee

This property is a notification text sent to a person when a mandate is removed.

Recipient: mandated person.
Available variables:

  • recipient: The name of the person receiving the notification.
  • invitee: "<firstname> <surname>" if the mandated entity is a person. The name of the organization of the mandated entity is an organization.
  • inviteeUser.<attribute name>: Any attribute the user has if the mandated entity is a person.
  • inviter: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandated entity is an organization.

email.mandateRemovedOrganization.inviter

This property is a notification text sent to an organization when a mandate is removed.

Recipient: mandater organization.
Available variables:

  • recipient: The name of the organization receiving the notification.
  • invitee: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandated entity is an organization.
  • inviteeUser.<attribute name>: Any attribute the mandatee has if the mandatee is a person.
  • inviter: "<firstname> <surname>" if the mandater is a person. The name of the organization if the mandater is an organization.

email.mandateRemovedOrganization.invitee

This property is a notification text sent to an organization when a mandate is removed.

Recipient: mandated organization.
Available variables:

  • recipient: The name of the organization receiving the notification.
  • invitee: "<firstname> <surname>" if the mandated entity is a person. The name of the organization if the mandated entity is an organization.
  • inviteeUser.<attribute name>: Any attribute the mandatee has if the mandatee is a person.
  • inviter: "<firstname> <surname>" if the mandater is a person. The name of the organization if the mandater is an organization.

email.pendingEmailConfirmation

This property is a notification text for confirming a new email address.

Recipient: user.
Available variables:

  • recipient: "<firstname> <surname>" of the user.
  • recipientUser.<attribute name> : Any attribute the user has.
  • email: The new email address.
  • confirmationcode: A code that should be entered to Ubisecure CustomerID user interface to activate the new email address.

email.pendingEmailRegistration

This property is a notification text for confirming a given email address during the registration workflow.

Recipient: user.
Available variables:

  • recipient: "<firstname> <surname>" of the user.
  • recipientUser.<attribute name>: Any attribute the user has.
  • email: The new email address.
  • confirmationcode: A code that should be entered to Ubisecure CustomerID user interface to activate the given email address.

NOTE: When this email is sent during a registration, you need to bear in mind that the user attributes given in the same input step as the email confirmation will not yet be available in the sent email. If the user attribute values are given in an earlier input step, then they are available.

email.emailResetPassword

This property is a notification text for sending the link for changing a password.

Recipient: user.
Available variables:

  • recipient: "<firstname> <surname>" of the user.
  • recipientUser.<attribute name>: Any attribute the user has.
  • link: The link where the password can be changed.

email.roleAdditionNotification

This property is a notification text for adding a particular role for the user. The role and addresses where the message will be sent to are configurable in the eidm2.properties configuration file.

Recipient: configured addresses.
Available variables:

  • roles_<locale>: The relative name of the role that has been added.
  • rolesFull_<locale>: The full name of the role that has been added.
  • name: "<firstname> <surname>" of the user to which the role has been added
  • organization: The organization of the user.
  • login: The login name of the user.
  • rolename: The technical name of the role.

email.roleRemovalNotification

This property is a notification text for removing a particular role from the user (see the property above).

Recipient: configured addresses.
Available variables:

  • roles_<locale>: The relative name of the role that has been removed.
  • rolesFull_<locale>: The full name of the role that has been removed.
  • name: "<firstname> <surname>" of the user from which the role has been removed.
  • organization: The organization of the user.
  • login: The login of the user.
  • rolename: The technical name of the role.
  • roleorganization: The organization where the role resides.

email.userMoveNotification

This property is a notification text for informing of the relocation of a user. The notification is sent to the organization administrators if the email.user.move has been set to true in the eidm2.properties configuration file.

Recipient: organization administrators.
Available variables:

  • user: "<firstname> <surname>" of the user that is being moved.
  • userObject.<attribute name>: Any attribute the user that is being moved has.
  • organization: The friendly name of the organization where the user is moved to.
  • organizationObject.<attribute name>: Any attribute the organization where the user is moved to has.

email.roleApproverApproved

This property is a notification text for informing the receiving user of a new role. This notification is sent regardless of if there was an approval needed to receive the role or not.

Recipient: user.
Available variables:

  • roles_<locale>: The relative name of the role that has been approved.
  • rolesFull_<locale>: The full name of the role that has been approved.
  • recipient: "<firstname> <surname>" of the user to which the role has been approved.
  • recipientUser.<attribute name>: Any attribute the user to which the role has been approved to has.
  • invitee: "<firstname> <surname>" of the user to which the role has been approved.
  • inviteeUser.<attribute name>: Any attribute the user to which the role has been approved to has.
  • organization: The friendly name of the role organization.

email.roleApproverDenied

This property is a notification text for informing the receiving user of the denial of a new role.

Recipient: user.
Available variables:

  • roles_<locale>: The relative name of the role that has been denied.
  • rolesFull_<locale>: The full name of the role that has been denied.
  • recipient: "<firstname> <surname>" of the user to which the role has been denied.
  • recipientUser.<attribute name>: Any Attribute the user to which the role has been denied to has.
  • invitee: "<firstname> <surname>" of the user to which the role has been denied.
  • inviteeUser.<attribute name>: Any Attribute the user to which the role has been denied to has.
  • organization: The friendly name of the role organization.

Workflow Specific Email Messages

The following emails can be further customized based on ongoing workflow:

  • email.pendingUser.creation
  • email.userApprovalRequest
  • email.userApprovalRequestRenotify
  • email.userExpired
  • email.roleInvite
  • email.roleInviteRenotify
  • email.mandateInvite.XXX

Workflow specific email messages are available for all messages that contain the variable user.pendingUserID.

For example, when creating a user invitation the email sent to the user by default uses the key email.pendingUser.creation. If the message should be different depending on the registration workflow used in the invitation it can be customized as follows. The example below shows how the workflow named retail will use a different message template to the worfklow named wholesale.  The first generic message is used for all other workflow names.

email.pendingUser.creation.enabled = true # or false, is this message enabled?
email.pendingUser.creation.subject = User invitation
email.pendingUser.creation.message = Dear ${user.firstname} ${user.surname},\n\n\
You are invited to use the system. \
Start the user registration here:\n\
${link}\n\n\
NOTE: Do not reply to this address.\n
email.pendingUser.creation.retail.enabled = true # or false, is this message enabled?
email.pendingUser.creation.retail.subject = You are invited to our online boutique
email.pendingUser.creation.retail.message = Dear ${user.firstname} ${user.surname},\n\n\
Congratulations on joining our loyalty program! \
Please enable your account here:\n\
${link}\n\n\
NOTE: Do not reply to this address.\n
email.pendingUser.creation.wholesale.enabled = true # or false, is this message enabled?
email.pendingUser.creation.wholesale.subject = You are invited to our warehouse system
email.pendingUser.creation.wholesale.message = Dear ${user.firstname} ${user.surname},\n\n\
You have been invited to access the warehouse management system. \
Check your information and complete the account verification process here:\n\
${link}\n\n\
NOTE: Do not reply to this address.\n

All the variables usable in these messages are the same as in their generic equivalents described above.
Please note that if you want to use these keys with localization a workflow-specific message must be defined also in the default mailmessages.properties file for the key to be enabled. Otherwise the default non-workflow-specific messages will be used.

  • No labels