Email templates

From iDENprotect Knowledge Base
Jump to: navigation, search


Using email templates

email templates are used to format and customise emails that the iDENprotect server sends to users. This article explains how you can change and modify these templates

Location of templates

A set of default templates are bundled in with the iDENprotect .jar file but if iDENprotect has been installed via RPM then there will be templates stored under

/etc/idenprotect/email-templates

If you wish to change the location of these templates you can specify the path to the folder in the setting called templateBaseDirectory under the email config screen.

Specifying Email Subject

On the email configuration tab the email subject to use for each email is specified.

Modifying Templates

For each email type, eg User Enrolment, there are two templates one for html and one for non-html. The non-html is used to send a plain-text version of the email in case the users email client is does not support html emails.

Templates consist of two elements. Those elements that are the same for all emails, and those that are specific for each email.

For example a plain-test email template

$user.firstName $user.lastName, 


You have been sent this email as part of your enrolment to the service. 
Please download the iDENprotect mobile phone app and scan the QR code at this $qrUrl

If you have any difficulties with this, please contact customer support on: TBC
Thank You

In this example when the email is sent the fields $user.firstName, $user.lastName and $qrUrl will be replace with the values specific to that user and enrolment session.

If you want to modify the format of the emails that are sent out you can create a copy of the email template file and the edit this file to change the wording as required ensuring that the references to the field names remain the same.


For the html templates the same principle applies but in this case you can include html mark-up, eg

 <html><body>
 
 <p>$user.firstName $user.lastName,</p>
 <br/>
 <p>You have been sent this email as part of your enrolment to the service. 
 Please download the iDENprotect mobile phone app and scan the QR code at </p>
 <div><a href="$qrUrl">$qrUrl</a></div>
   
 <p>If you have any difficulties with this, please contact customer support
  on: TBC</p>
 <p>Thank You</p>
 
 </body>
 </html>

Once you have created the new template files, you can change the settings on the email config tab on the admin console.