Templates: Batched issue notifications and other events

Still need help?

The Atlassian Community is here for you.

Ask the community

The archive that you downloaded from Jira contains email templates from all available configuration options. It’s easy to get lost in the files and their dependencies, especially that not all of them apply to your configuration. Use this page to understand the templates and the notifications they control.

This page is for default Jira notifications

This page is for default Jira notifications that are using batched issue updates. If you’re using separate issue notifications, see Separate issue notifications.

Not sure which notifications you’re using?

Definitions

We’re referring to templates and includes around this page. Since all of them are Velocity templates, here’s the best way to understand them:

  • Templates: Main templates used for notifications. Usually, a template like that is a notification that you’re getting. You’d modify them if you’d like to customize the looks of a specific notification rather than an item that is shared with all notifications, like footer.

  • Includes: Includes aren’t used on their own, but are always referenced in main templates. You’d modify them if you’d like to customize the looks of an item shared with all notifications rather than the notification itself. For example, changing footers or headers.

Issue notifications

Templates

These templates control notifications about issues (summary emails).

Directory: templates/email-batch/html

TemplateDescriptionIncludes
IssueUpdateBatcher-subject.vm

Email subject for batched issue updates.

-

IssueUpdateBatched-header.vm

Email header. This includes:

  • Text summarizing the updates (There is 1 comment)

  • Issue details: Project, name, key, summary, actions

-

IssueUpdateBatcher-content.vm

Main part of the email where issue updates are shown. The updates themselves, however, are retrieved by the next template (below) which is included in this one.

  • Templates: IssueUpdateBatcher-history.vm

  • Templates: IssueUpdateBatcher-header.vm

  • Includes: hr-bottom.vm

  • Includes: footer.vm

IssueUpdateBatcher-history.vm

Provides the summary of issue updates: comments, updates, work logs, mentions, and issue status (moved, assigned, archived, deleted, etc.).

  • Templates: shared/mention-text.vm

Includes

List of includes referenced in main templates for issue notifications.

Directory: templates/email-batch/html

View Includes...
TemplateDescriptionIncluded in
hr-bottom.vm

Generates the divider (horizontal line).

  • Template: IssueUpdateBatcher-content.vm

template.vm

Root template. Provides the base of the HTML document that is sent as notification email.

  • Templates: IssueUpdateBatcher.vm

footer.vm

Footer of batched issue notifications.

  • Template: IssueUpdateBatcher-content.vm

../shared/mention-text

Adds an extra line of text to batched issue notifications if you were mentioned in an issue.

  • Template: IssueUpdateBatcher-history.vm

Other notifications

These notifications control other events like sharing filters or user management.

Share templates

Directory: templates/email/html

TemplateDescriptionIncludes
shareissue.vm

Someone is sharing an issue with you.

  • Includes: header.vm

  • Includes: footer.vm

  • Patterns: involvedUsers.vm

  • Patterns: comment-top.vm

  • Patterns: issue-title.vm

  • Templates: mobileSingleColumnStyle.vm

sharejqlsearch.vm

Someone is sharing a JQL search with you.

  • Includes: header.vm

  • Includes: footer.vm

  • Patterns: involvedUsers.vm

  • Patterns: comment-top.vm

  • Patterns: page-title.vm

  • Templates: mobileSingleColumnStyle.vm

sharesavedsearch.vm

Someone is sharing a saved search (filter) with you.

  • Includes: footer.vm

  • Patterns: involvedUsers.vm

  • Patterns: comment-top.vm

  • Patterns: page-title.vm

  • Templates: mobileSingleColumnStyle.vm

Contact admin templates

Directory: templates/email/html

TemplateDescriptionIncludes
contactadministrator.vm

Notification that Jira admin is getting after someone tries to contact them over the Contact Admin form.

  • Includes: header.vm

  • Includes: footer.vm

  • Patterns: page-title.vm

  • Patterns: text-paragraph.vm

emailfromadmin.vm

Emails sent to users directly from the Jira admin.

  • Includes: footer.vm

  • Patterns: page-title.vm

  • Patterns: text-paragraph.vm

User management templates

Directory: templates/email/html

TemplateDescriptionIncludes
usercreated.vm

New user was created. Notification for Jira admins.

  • Includes: header.vm

  • Includes: footer.vm

  • Includes: userdetails.vm

  • Patterns: button-action.vm

  • Patterns: page-title.vm

  • Patterns: text-paragraph.vm

usercreated-nopassword.vm

New user was created in an external directory, and their password can’t be changed. Notification for Jira admins.

  • Includes: header.vm

  • Includes: footer.vm

  • Includes: userdetails.vm

  • Patterns: page-title.vm

  • Patterns: text-paragraph.vm

usersignup.vm

Notification users receive after signing up to Jira.

  • Includes: header.vm

  • Includes: footer.vm

  • Includes: userdetails.vm

forgotusername.vm

Notification users receive if they forget their usernames.

  • Includes: header.vm

  • Includes: footer.vm

forgotpassword.vm

Notification users receive if they forget their password.

  • Includes: header.vm

  • Includes: footer.vm

  • Includes: userdetails.vm

Other notifications: Includes

List of includes referenced in main templates.

Directory: templates/email/html/includes

View Includes...
TemplateDescriptionIncluded in
emailconstants.vm

Fonts and colors of headers, headings, and links.

  • macros.vm

  • footer.vm

  • header.vm

footer.vm

Email footer.

Share:

  • shareissue.vm

  • sharejqlsearch.vm

  • sharesavedsearch.vm

Contact admin:

  • contactadministrator.vm

  • emailfromadmin.vm

User management:

  • usercreated.vm

  • usercreated-nopassword.vm

  • usersignup.vm

  • forgotusername.vm

  • forgotpassword.vm

header.vm

Email header.

Share:

  • shareissue.vm

  • sharejqlsearch.vm

Contact admin:

  • contactadministrator.vm

User management:

  • usercreated.vm

  • usercreated-nopassword.vm

  • usersignup.vm

  • forgotusername.vm

  • forgotpassword.vm

userdetails.vm

Details of a user: username, email address, display name.

User management:

  • usercreated.vm

  • usercreated-nopassword.vm

  • usersignup.vm

  • forgotpassword.vm

Other notifications: Patterns

It’s unlikely that you’ll need to edit any of the pattern templates. They contain reusable components that are common for the Jira UI, like action buttons, titles, or text paragraphs. If you wanted to check them out anyway, you can find them in templates/email/html/patterns.

Last modified on Nov 24, 2020

Was this helpful?

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