Customize the Notification Email Template

Last modified by Eleni Cojocariu on 2026/10/14 12:04

Steps

The mail the wiki sends is rendered from an XWiki.Mail object stored in the XWiki.Notifications.MailTemplate page, so changing its wording or layout is an ordinary page edit; Notifications says where the rest of the mail behaviour is configured.

  1. Navigate to the XWiki.Notifications.MailTemplate page and edit its objects.
  2. Open the XWiki.Mail object it holds.

    The XWiki.Mail object of the notification mail template

  3. Edit the html property for the HTML part of the mail and the text property for its plain-text part.
  4. Attach to the page any image the template needs, and reference it in the html property by its attachment name.
    <img src="cid:my-logo.png"/>
  5. Save the page and check that the object holds your version of the template.

    The saved XWiki.Mail object holding the edited template

FAQ

Can I show an image in the plain-text part?

No. The text property carries text only, so decide separately what it says where the HTML part shows a picture.

Will an upgrade overwrite my template?

The page is shipped by the extension, so an upgrade proposes to replace it; keep your version when the Distribution Wizard asks.

Related

Get Connected