Nuxeo Server

How to Customize Email Templates

Updated: December 19, 2017 Page Information Edit on GitHub

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.

Overriding Default Alert Emails

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

  1. Create a new Templates > Mail feature in Studio. Choose ID among the ones that are used in the default product, like subscriptionsUpdated for instance (see the list of all alert templates).
  2. Fill in 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.
  3. 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 name="notificationDocId"
                     enabled="true"
                     prefix="nxdoc"
                     priority="1000"
                     class="org.nuxeo.ui.web.url.codec.JSFNotificationDocumentIdCodec" />
</extension>

a month ago Solen Guitter NXDOC-1418
a month ago Solen Guitter Reuse content from How to make JSF UI the default UI instead of duplicate
a month ago Manon Lumeau Add tags for doc days
2 months ago manonlumeau Added content-review-lts2017 label
3 months ago manonlumeau NXDOC-1346-FT review screenshot
2 years ago Solen Guitter 18
2 years ago Solen Guitter 17 | Fix broken link
3 years ago Solen Guitter 16
3 years ago Solen Guitter 15
3 years ago Solen Guitter 14 | merging page with Create a mail template
3 years ago Solen Guitter 13
3 years ago Solen Guitter 12
3 years ago Solen Guitter 11
4 years ago Solen Guitter 9
4 years ago Solen Guitter 10
5 years ago Solen Guitter 8 | Added link to list of notification templates in Explorer
6 years ago Solen Guitter 6 | Added link to related howto
6 years ago Solen Guitter 7 | Migrated to Confluence 4.0
6 years ago Alain Escaffre 4
6 years ago Alain Escaffre 5
6 years ago Alain Escaffre 3
6 years ago Alain Escaffre 1
6 years ago Alain Escaffre 2
History: Created by Alain Escaffre