Contexts
Contexts connect various configurations and settings to a scope. The scope of a context can be composed of:
A project (optional)
An Issue Type (optional)
A JQL filter (optional)
The scope determines which issues the Context is applicable for based on the Context Resolution Algorithm. These are displayed in the Contexts menu in an expandable list.
Context attributes
Context attributes have the following main aspects:
The scope for which the context is set (project/issue type/JQL)
The content that is applicable to the scope
The Email This Issue notifications applicable to the scope
Additional settings within the scope
Adding a new context
To create a new Context do the following:
1. Go to OUTGOING EMAILS --> Contexts.
2. Click the Add button.
Scope
The scope maps all the context settings to a certain project/issue type/JQL or a combination of these.
| Attribute | Description |
|---|---|
Project | Defines the project to which the context is applied. Applied to all projects if left empty. |
Issue Type | Defines the issue type to which the context is applied. Applied to all issue types if left empty. |
JQL Filter | Defines a JQL condition to match the set of issues the context may be applied to. JQL Filter with a combination of Project and Issue Type selected is used to determine if the Context is applicable to an Issue being sent in an email. |
Description | A description of the Context. |
Order | Defines the order in which the Contexts configured with the same combination of Project and Issue Type are evaluated (see examples here). |
Content and Notifications
The content of a context specifies templates and canned responses to be used when sending manual emails.
| Attribute | Description |
|---|---|
Template | Defines the default email template that Jira Email This Issue will use when emails are sent. The template selected here is not visible on the email screen's editor, it can be thought of as a frame for your emails. Read more here. |
Mail Body Initializer Template | A template used for initializing the email subject and body on the email screen. Read more here. |
Template Categories | Categories are groups of email templates. Once selected here, users are able to choose a template from the given category on the email screen's dropdown list. Read more here. |
Notification | Defines issue event notifications for the context. They can work alongside Jira Notification Schemes, and allow you to fully customize notifications. Read more here. |
Note: Either a Template or a Notification is mandatory. You cannot create "empty" contexts without at least either one of these.
Additional Settings
Additional content settings allow you to further configure options for your outgoing emails.
| Attribute | Description |
|---|---|
Field for External Watchers | A text custom field where non-Jira user email addresses will be saved if the "Add recipients to watchers" option in Manual Email Default settings is enabled. Read more here. |
Sender Name Pattern | A velocity markup pattern or a static text to format a sender name in outgoing emails. E.g. if you don't want to show the name of real users as the sender of emails, you can include the project name or the value of a custom field. Note: Not all SMTP servers allow for this setting. Please check your SMTP server options for confirmation. |
From Address Pattern | Velocity markup pattern or a static email address to format the From Address in outgoing emails. E.g. if you don't want to show the name of real users as the sender of emails, you can include the project name or value of a custom field. Note: Not all SMTP servers allow for this setting, please check your SMTP server options for confirmation. |
Reply-To Address Pattern | Velocity markup pattern or a custom email address to format the Reply-to Email Address in outgoing emails. This is very useful if your IMAP and SMTP server addresses are different. |
Bcc Address | A single email address, if specified, will be added as a Bcc recipient in all emails sent via this Context. |
Email Details in Comments | Option to set whether comments should include the email details (such as To:, From:, Attachments in the email etc.). This option is about comments that are created from manual outgoing emails and added to the issue. |
Send Individual Emails | Enable this if you want each recipient to receive a separate email instead of sending a single email to all recipients. Learn more about this feature |
SMTP Connection | Select the SMTP connection to be used to deliver emails via this Context. Default is Jira's outgoing mail setting. SINCE 7.1.1.17 |
Email Headers | Custom Email headers of outgoing emails may be set using this attribute. The field should contain email headers in the format of SINCE 8.0.6 |
Enabling/disabling contexts
Contexts may be disabled and enabled again. This allows admins to test their configuration without having to remove or change contexts. Disabled contexts are disregarded in the context resolution algorithm explained above.
Last updated
