Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Required permission: user with Jira Administrator permissions.
Jira administrator can configure the global settings of Email Notifications Digest for all users in the system.

Global configuration allows to turn on/off the digest for all users, define the type of notifications and the maximum amount of updates per digest, default email digest schedule.

Global Email Notification Digest Configuration is available from JIRA Administration → Add-ons → Manage Add-ons → Email Notification Digest add-on → Configure button.

Info

Alternatively, global configuration can be opened from a personal configuration page (if user has Jira Administrator permissions).

          

Image Removed

Global Configuration settings include:

  • Enable Email Notifications Digest plug-in:
    • Use Email Notifications Digest add-on to manage email notifications

      • Notification digest will be sent to users in the system depending on the global settings. Every user can set up Personal Configuration that reconfigure settings from Global Configuration. 
        Image Removed
    • Do not allow users to customize their own Personal Digest settings
      • Notification digest will be sent to users in the system depending on the global settings. Users are not allowed to configure own digest.
        Image Removed

Who should receive emails

Email Notifications Digest contain three types of notifications: 

  • Instant Updates
  • Issue Digest
  • Summary Digest

Image Removed

  • Enable Email Notifications Digest plug-in for users (for every Digest mode):

...

Image Removed

...

Notification digest will be sent to all users in the system at specified date/time 

...

Notification digest will be sent to the users that belong to specific Jira group only 

...

Notification digest will not be sent to any user 

...

Defines who should receive all the default JIRA issue updates emails.

...

Instant Updates will be sent immediately per each issue change. You can select wich updates can be send in "Which updates to send" section. 

...

Tips: Keep "All" or selected "Group"  to continue to receive default Jira email notifications in addition to Issue and Summary Digest.

...

Issue Digest
  • Defines who should receive frequent digest emails per issue. 

  • Issue Digest waits and collects issue updates for several minutes before sending. The waiting time (from the time when you stop update issues) you can configure in "When to send emails" section and wich updates to be send in "Which updates to send" section.

  • Default value = All

...

Summary Digest
  • Defines who should receive a summary digest emails based on date/time schedule. 

  • Summary Digest collects updates from various issues within a day and sends them in a single email per defined schedule in "When to send emails" section.

  • Besides Scheduler you can configure maximum number of updates to be send when maximum updates will be reached in "Which updates to send" section ("Maximum number of updates in a Summary Digest email" should be empty).

  • Default value = All

Which updates to send

Admin can configure the filling of Email Notification Digest:

...

Choose which issue update events should be included or/and ignored in email notification:

Include these issue events in any of notification emails

...

Some issue events can be included ot not included in all three modes (Instant Updates, Issue Digest, Summary Digest) Image Removed

...

Ignore changes made to the following issue fields

...

Some issue events can be ignored in all three modes (Instant Updates, Issue Digest, Summary Digest).

...

Info
iconfalse
titleThe full list of issue fields that can be ignored in email notifications

Affects Versions, Assignee, Components, Created, Description, Due Date, Environment, Fix For Versions, Issue Level Security, Issue Type, Priority, Summary, Time Spent, Time Tracking, Development, End Date Time, Epic Color, Epic Link, Epic Name, Epic Status, Planned End Date, Planned Start Date, Radio Button field, Rank, Sprint, Start Date Time, Story Number, Story Points, Story number, Text multiple, Text single

  • Add notification email for Project Leads:

    • Project Lead settings
      • Admin can include Project's Leads to receive the digests witall project update even if  project lead is not a watcher of updated issues.
      • Default value = selected

...

Default number = 300

Note

The system will send a Summary Digest email immediately once maximum number of updates is reached.

When to send emails

Image Removed

...

Instant Updates will be sent instantly when each issue update happens. 

Issue Digest updates cellect period

...

Issue Digest will wait some period of time (from 1 min to 10 min) when you stop updating the tickets and collect issue updates of this period before sending email.

...

Collect period is a period of time to wait before send an email.

Default values = 5 min

...

Summary Digest email schedule
  • Summary Digest collect the changes made between the scheduled period. 
  • Defines date and time at which digest will be sent to users' emails. 
  • Click on a cell when you would like to receive a digest email.
  • Default values = 8 am, 7 pm Mon - Fri

Advanced Configuration

In Advanced Configuration Admin can configure different notifications besides the main one and ignore some projects for Email Notification Digest. 

...

Priority Projects:

...

  • Select Priority Projects below 
    • You will receive different notifications for Priority Projects besides the main

Select the type of digest for that projects:

...

  • Frequent digest emails per issue will be sent. You can choose  the period time in "When to send emails" section

...

Select which updates to sent: 

  • Always send all issue updates from Priority Projects 
    • Checked: all updates will be sent and updates in "Which updates to send" section will be ignored.
    • Unchecked: configuration in "Which updates to send" section will be user for Priority Projects.

Ignored Projects:

  • Select the project that will be ignored by Email Notification Digest:
    • Select Ignored Projects below 
      • Digest will be turned off for ignored projects. Default Jira notification emails will be sent for Projects' users.

Select the type of digest for that projects:

...

  • Frequent digest emails per issue will be sent. You can choose the period of time to wait before send an email in "When to send emails" section

Email Templates Customization

Image Removed

To configure Email Templates possible for Summary Digest and Issue Digest. Edit Summary Digest email subject line and Summary Digest email header line to configure your own. 

  • Select the issue fields that will be included in email of Issue Digest:
    • Add these issue fields into each Issue Digest email
      • Example: some of the issue fields could be useful and gve more information about the ticket like Due Date or Prioruty. Added issue field will be displaying in every Issue Digest.

...

iconfalse
titleAdditional issue fields into each Issue Digest email

...

Required permission: user with Jira Administrator permissions.
Jira administrator can configure the global settings of Email Notifications Digest for all users in the system.

Global configuration allows to turn on/off the digest for all users, define the type of notifications and the maximum amount of updates per digest, default email digest schedule.

Global Email Notification Digest Configuration is available from JIRA Administration → Add-ons → Manage Add-ons → Email Notification Digest add-on → Configure button.

Info

Alternatively, global configuration can be opened from a personal configuration page (if user has Jira Administrator permissions).


Image Added

Global Configuration Settings

  • Enable Email Notifications Digest plug-in:
    • Use Email Notifications Digest add-on to manage email notifications

      • Notification digest will be sent to users in the system depending on the global settings. Every user can set up Personal Digest Configuration that reconfigure settings from Global Configuration. 
        Image Added
    • Do not allow users to customize their own Personal Digest settings
      • Notification digest will be sent to users in the system depending on the global settings. Users are not allowed to configure own digest.
        Image Added

Who should receive emails

Email Notifications Digest contain three types of notifications: 

  • Instant Updates
  • Issue Digest
  • Summary Digest

Image Added

  • Enable Email Notifications Digest plug-in for users (for every Digest mode):
Image Added

Image Added

Image Added

Notification digest will be sent to all users in the system at specified date/time 


Notification digest will be sent to the users that belong to specific Jira group only 

Notification digest will not be sent to any user 


  • Choose what type of notification will be sent:
    • Instant Updates
      • Defines who should receive all the default JIRA issue updates emails.

      • Instant Updates will be sent immediately per each issue change. You can select which updates can be sent in "Which updates to send" section. 

      • Default value = Nobody
      • Tips: Keep "All" or selected "Group"  to continue to receive default Jira email notifications in addition to Issue and Summary Digest.


    • Issue Digest
      • Defines who should receive frequent digest emails per issue. 

      • Issue Digest waits and collects issue updates for several minutes before sending. The waiting time (from the time when you stop update issues) you can configure in "When to send emails" section and which updates to send in "Which updates to send" section.

      • Default value = All
    • Summary Digest
      • Defines who should receive a summary digest emails based on date/time schedule. 

      • Summary Digest collects updates from various issues within a day and sends them in a single email per defined schedule in "When to send emails" section.

      • Besides Scheduler, you can configure the maximum number of updates to be sent when maximum updates will be reached in "Which updates to send" section ("Maximum number of updates in a Summary Digest email" should be empty).

      • Default value = All

Which updates to send

Admin can configure the filling of Email Notification Digest:

Image Added

  • Choose if your changes should be included in Digest:

    • Include my changes in emails

Image Added

  • Choose if you should receive Digest when someone mentioned you in a comment:

    • Someone mentioned me in a comment
    • Included in Summary Digest only

Image Added

  • Choose which issue update events should be included or/and ignored in email notification:

    • Include these issue events in any of notification emails

      • Some issue events can be included or not included in all three modes (Instant Updates, Issue Digest, Summary Digest) Image Added

      • Default value = all issue events are selected

    • Ignore changes made to the following issue fields

      • Some issue events can be ignored in all three modes (Instant Updates, Issue Digest, Summary Digest).

      • Default value = empty
        Image Added


Info
iconfalse
titleThe full list of issue fields that can be ignored in email notifications

Affects Versions, Assignee, Components, Created, Description, Due Date, Environment, Fix For Versions, Issue Level Security, Issue Type, Priority, Summary, Time Spent, Time Tracking, Development, End Date Time, Epic Color, Epic Link, Epic Name, Epic Status, Planned End Date, Planned Start Date, Radio Button field, Rank, Sprint, Start Date Time, Story Number, Story Points, Story number, Text multiple, Text single


  • Add notification email for Project Leads:

    • Project Lead settings
      • Admin can include Project's Leads to receive the digests witall project update even if project lead is not a watcher of updated issues.
      • Default value = selected
        Image Added
  • Select Maximum number of updates per digest in Summary Digest:
    • Defines the maximum number of updates in Jira after which the digest should be sent to users' emails
    • Default number = 300

      Image Added

      Note

      The system will send a Summary Digest email immediately once the maximum number of updates is reached.


When to send emails

Image Added

  • Choose when notification will be sent:
    • Instant Updates emails
      • Instant Updates will be sent instantly when each issue update happens. 


    • Issue Digest updates collect period
      • Issue Digest will wait some period of time (from 1 min to 10 min) when you stop updating the tickets and collect issue updates of this period before sending an email.

      • Collect period is a period of time to wait before sending an email.

      • Default values = 5 min


    • Summary Digest email schedule
      • Summary Digest collects the changes made between the scheduled period. 
      • Defines date and time at which digest will be sent to users' emails. 
      • Click on a cell when you would like to receive a digest email.
      • Default values = 8 am, 7 pm Mon - Fri

Advanced Configuration

In Advanced Configuration Admin can configure different notifications besides the main one and ignore some projects for Email Notification Digest. 

Image Added

Priority Projects:

  • Select the project that is a priority for you and needs a special attention:
    • Select Priority Projects below 
      • You will receive different notifications for Priority Projects besides the main

  • Select the type of digest for that projects:

      • All the default JIRA issue updates emails will be sent.
      • Frequent digest emails per issue will be sent. You can choose the period of time in "When to send emails" section
  • Select which updates to send: 

    • Always send all issue updates from Priority Projects 
      • Checked: all updates will be sent and updates in "Which updates to send" section will be ignored.
      • Unchecked: a configuration in "Which updates to send" section will be used for Priority Projects.

Ignored Projects:

  • Select the project that will be ignored by Email Notification Digest:
    • Select Ignored Projects below 
      • The digest will be turned off for ignored projects. Default Jira notification emails will be sent for Projects' users.


  • Select the next checkbox if the default notifications from Jira should be sent in addition to the Digests :

    • tification Schemes for All Projects
      • This setting is not recommended. With this option Jira will continue to send default immediate notification emails based on Jira Notification Schemes. Filters and aggregation from "Which updates to send" section will not be applied.
        Image Added

Image Added


Compatibility and Processing: v3.4.0+

  • Additional users to be notified
    • Select Multi-User Picker custom fieldof users who should also receive notification emails on issue updates. 
      • The system will notify users from that custom field in addition to Assignee, Reporter and issue Watchers.

      • Default: None
  • Event Processing

    • Compatibility mode with other add-ons
      • If enabled then email digest will wait several seconds before collecting updates to give some time for other post-function/post-workflow action add-on to complete their updates on an issue.
      • Default: Unchecked

Email Templates Customization

Image Added


To configure Email Templates possible for Summary Digest and Issue Digest. Edit Summary Digest email subject line and Summary Digest email header line to configure your own. 

Instant Updates Settings

  • Select the email address from which emails should be sent:

      • To check the email address configuration for Default email address in Jira: go to Jira → Jira Administration → System → On the left menu bar: Mail →  Outgoing Mail → check "From" field to see your mail server currently configured for Jira
      • If the "From" email address is redefined for specific projects then the add-on will use that email address to send notifications of changes in that project. This will override the default "From" email address configuration for these projects. To check the Notifications for specific project in Jira: go to Jira → Jira Administration → Projects → click on a Project name (that you want to check) in Project list → Summary → Notifications →
        • check "Email" field to see your email address for current project for Jira

      • To check the email address configuration for specific user possible in User Management page or in a user's profile.


  • Customize the Email Subject line and Header line. 

    Image Added
  • Select the issue fields that will be included in an email of Issue Digest:
    • Add these issue fields into each Issue Digest email
      • Example: some of the issue fields could be useful and give more information about the ticket like Due Date or Priority. Added issue field will be displayed in every Issue Digest.

Info
iconfalse
titleAdditional issue fields into each Issue Digest email

Affects Versions, Assignee, Components, Created, Description, Due Date, Environment, Fix For Versions, Issue Level Security, Issue Type, Priority, Summary, Time Spent, Time Tracking, Story Number, Story Points, Story number, Text multiple, Text single


  • Customize the interface of email (header background, text color, logo image):
    • Click Preview Template link to see the changed Email Template.

Personal Config of user:

Admin has permission to see and configure the other users' settings.

  • Select the user to change his settings:

    • Fill in and search any Jira user in the field; click "Show" to see the users' Personal Configuration page

      • Example: Admin will see the warning message on users' personal page:

Image Added

Note

For the changes to be applied, admin should press Save button.
To reset add-on configuration to default click the link on the right down corner.


  • Enable Email Notifications Digest plug-in:
    • to temporary turn off the Email Notification Digest select "Use Jira`s built-in default email notifications" - all users will receive regular Jira notifications.

...