Documentation for Confluence 5.7.
Documentation for Confluence Cloud and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata

Customising 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 customisations 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 bundled plugin (add-on) 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. In your Confluence test instance go to > Add-ons and upload your new jar file. 
  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. 

RELATED TOPICS

10 Comments

  1. Anonymous

    I need to modify the template for the email sent using "Share" button but I did not find it in the confluence-3.5.jar.

    Where can I find this template?

    1. Hello there,

      You can find the template of "Share" emails in the Share plugin itself which is located at confluence-install/confluence/WEB-INF/classes/com/atlassian/confluence/setup/atlassian-bundled-plugins.zip/share-page-1.6.jar/templates/.

      Hope that helps,
      Husein

  2. Is there no possibility to change the email templates via a plugin (e.g. decorator)

  3. Default Confluence email text for user registration goes straight to the spam box. If I could edit it using a plugin then I could try to avoid this.

    Branding is a big concern, too. Using the system as an extranet means that we need to finely tune the message so that people don't get confused when they receive the email.

    Is there a ticket about this issue (being able to edit email text)?

  4. After so many years - no chance?

  5. Hi,

    I am writing a plugin that will send emails to users watching a page. Using the example email plugin, I am using the ConfluenceMailQueueItem.

    Is there any way to create a mail item using the standard confluence mail template so the email I create from my plugin looks like any other email from Confluence?

  6. Hello!

    I can't find file confluence-email-resources-x.x.jar in my Confluence directory. I use Confluence 5.5.2. System hasn't been transformed.

    Please tell me where is it?

    Thank you!

    Serafim

    1. Hi Serafim, yes, it looks like the plugin that provides the mail templates changed in 5.5.  I'm finding out about the changes and will update this page if it is still possible to customise these templates. 

      1. Hi Rachel!

        I'm happy to see your answer! I hope, solution is still possible.

        Thanks a lot!

        Serafim

  7. v t

    Hi, a question, how add the page id to the template. I need show this in the footer