Introduction

You can create new (and modify existing) template messages to customize the body of notification messages. This can be achieved by creating and / or modifying the notification e-mail template files.

Template files

Templates are defined by their name.

Each template is made up of a couple of files:

• the rich-text HTML variant (with extension .html.vm)
• the plain text variant (with extension .txt.vm)

For example, the default optin template is defined by:

• optin.html.vm
• optin.txt.vm

Template location

Assuming you have generated and built your own project, existing templates (including the default optin template) are located under

core/target/syncope/WEB-INF/classes/mailTemplates/

You need to create your own template files (or copy existing to modify) under

core/src/main/resources/mailTemplates/

Template format

Template files are interpreted using the Velocity engine; check the language reference.

Besides standard expressions, you can use the following Syncope-specific variables:

• user
  UserTO instance representing the subject of the current notification
• syncopeConf
Map<String, String> containing all defined configurations as <key, value> - see how to manage these items
• recipients
  list of UserTO instances for all the actual recipients of the current notification e-mail
• events
  list of String containing all the events that triggered the current notification