Templates: Batched issue notifications and other events
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.
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
| Template | Description | Includes |
|---|---|---|
| IssueUpdateBatcher-subject.vm | Email subject for batched issue updates. | - |
| IssueUpdateBatched-header.vm | Email header. This includes:
| - |
| 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. |
|
| IssueUpdateBatcher-history.vm | Provides the summary of issue updates: comments, updates, work logs, mentions, and issue status (moved, assigned, archived, deleted, etc.). |
|
Includes
List of includes referenced in main templates for issue notifications.
Directory: templates/email-batch/html
Other notifications
These notifications control other events like sharing filters or user management.
Share templates
Directory: templates/email/html
| Template | Description | Includes |
|---|---|---|
| shareissue.vm | Someone is sharing an issue with you. |
|
| sharejqlsearch.vm | Someone is sharing a JQL search with you. |
|
| sharesavedsearch.vm | Someone is sharing a saved search (filter) with you. |
|
Contact admin templates
Directory: templates/email/html
| Template | Description | Includes |
|---|---|---|
| contactadministrator.vm | Notification that Jira admin is getting after someone tries to contact them over the Contact Admin form. |
|
| emailfromadmin.vm | Emails sent to users directly from the Jira admin. |
|
User management templates
Directory: templates/email/html
| Template | Description | Includes |
|---|---|---|
| usercreated.vm | New user was created. Notification for Jira admins. |
|
| usercreated-nopassword.vm | New user was created in an external directory, and their password can’t be changed. Notification for Jira admins. |
|
| usersignup.vm | Notification users receive after signing up to Jira. |
|
| forgotusername.vm | Notification users receive if they forget their usernames. |
|
| forgotpassword.vm | Notification users receive if they forget their password. |
|
Other notifications: Includes
List of includes referenced in main templates.
Directory: templates/email/html/includes
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.