HOWTO: Customize Email Templates

Updated: June 14, 2024

An email template defines the content of an email that is sent to users under predefined circumstances. An email template is usually composed of text and variables. Typically, email templates are used to define the content of email alerts in the Nuxeo Platform.

Creating an Email Template

To create a new mail template:

  1. Go to Templates > Mail Templates.
  2. Click on the New button to create a new mail template.
  3. Give the mail template a ID and click Next.
  4. In the text area, type the content of the mail. The content is usually composed of text and variables.
  5. When you're done, click Save. Your mail template is saved and can be used in automation chains.

Updating Default Alert Emails

Default templates for mail notifications can be updated. Just follow those steps:

  1. Go to Templates > Mail Templates.
  2. Click on the line of the mail template to be updated.
  3. Update the content of the email that you want to be sent.
    If you want to copy from the default content of the template, you can have a look at it from GitHub.
  4. Save.

To make the document permalinks generated by the server (and used in email notifications typically) point to the JSF UI instead of the Web UI you need to add the following XML contribution:

<extension target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService" point="codecs">
  <documentViewCodec class="org.nuxeo.web.ui.url.codec.WebNotificationDocumentIdCodec"
                     priority="1000" />