Customizing Email Templates

Customizing the Confluence email templates is not supported. If you do decide to edit the templates we strongly recommend you use a test instance of Confluence. 

Any customizations you make to the Confluence email notification templates will need to be reapplied after upgrading Confluence.

Email notification templates are contained within the confluence-email-notifications plugin, which is a system app (plugin) that is installed automatically when you install Confluence. 

Only administrators with access to the Confluence installation directory can modify the Confluence email templates.

Confluence uses Soy templates (also known as Closure templates) for email notifications. You can find out more in the Google Developer docs or see our developer tutorial which contains a short introduction to using Soy templates.

 To change the email notification templates:

  1. In the Confluence web application folder, find the file /confluence/WEB-INF/atlassian-bundled-plugins/confluence-email-notifications-plugin-x.x.jar 
    Note: This plugin is independently versioned, the version number will not necessarily match Confluence's version number.  
  2. Copy this file to a working location and extract the jar file. Find out more about how to edit files within .jar archives.
  3. Within the jar file, templates are stored in the /templates/ folder. Edit the Soy templates to make your changes. 
  4. Zip all the files and change the file extension to .jar (or refer to the guide on editing files within .jar archives for other methods).
  5. Drop the new jar file into the /confluence/WEB-INF/atlassian-bundled-plugins folder (replacing the original file - you might want to make a copy of the original file for easy roll back) and then restart your instance. 
  6. Test your changes carefully before installing the updated plugin in production.

We strongly recommend you use a test instance for editing the templates contained within the plugin.  If you are unable to enable the plugin, check the Confluence logs for information, it may be that there are problems with your edits to the Soy templates. 

Last modified on May 25, 2023

Was this helpful?

Provide feedback about this article
Powered by Confluence and Scroll Viewport.