How to create a custom mail template in Jira Data Center

Still need help?

The Atlassian Community is here for you.

Ask the community

This page is for Jira Data Center

If you’re using Jira Server, please consult the Customizing email content in Jira Server.

Customizations to Velocity templates or other Jira files are not included in the scope of Atlassian Support.

Summary

This article is an extension of Customizing email content for Jira Data Center administration page. To create a new email template in Jira Data Center, to be used along with specific Jira event, there are specific steps to be followed, listed below.

Please note since Jira 8.14 Jira changed the format to download/upload templates, read more on Jira 8.14 release notes (Email templates made better). This article applies to version 8.14 or later. 

Steps 

  1. Download the email templates from Administration > System > Email templates
  2. Using the structure from the downloaded Zip file, create new template.vm files in the htmltext , and subject directories, based on the existing files in those directories
  3. Zip the templates folder and upload the zipped email templates on Administration > System > Email templates (note it will overwrite the information in <Jira-shared-home>/data/templates/email).
  4. Edit the <Jira app folder>/atlassian-jira/WEB-INF/classes/email-template-id-mappings.xml adding the created templates to make them valid choices for when you are adding a new event.
  5. Restart Jira


Example

  1. Download the email templates from Administration > System > Email templates
  2. Using the structure from the downloaded Zip file, create new template.vm files in the htmltext , and subject directories, based on the existing files in those directories
  3. Zip the templates folder and upload the zipped email templates on Administration > System > Email templates (note it will overwrite the information in <Jira-shared-home>/data/templates/email).

  4. Edit the <Jira app folder>/atlassian-jira/WEB-INF/classes/email-template-id-mappings.xml adding the created templates to make them valid choices for when you are adding a new event.
  5. Restart Jira
  6. Validation





Last modified on Oct 26, 2022

Was this helpful?

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