| Table of Contents |
|---|
...
The handler type must be set to Email This Issue Mail handler in Jira.
Below is an example for Jira's Incoming Mail Handler with Email This Issue Mail Handler type:
Mail Handler Contexts
...
Mail Handler Contexts are used in conjunction with the JETI Email This Issue Mail Handlers. If you set up the handler to create issues in the project "MyProject" of issue type "Bug", there must be a Mail Handler Context configured to match this combination, e.g. a Mail Handler Context configured with project "MyProject" or issue type "Bug" or both.
Mail Handler Context Attributes
| Attribute | Description | Required | ||
|---|---|---|---|---|
| Scope | Project: to which the context applies. If left empty, context applies to all projects. Issue Type: to which the context applies. If left empty, context applies to all issue types. | (error) | ||
| Email Processing | Email Processing Strategy: Determines how Email This Issue Mail Handler processes incoming emails. There are various strategies available out-of-the-box:
Handler actions (available for all the above strategies):
|
| ||
| Acknowledge Incoming Emails | Event: An issue event that is fired for each incoming email that the mail handler processes (read on for more information). Acknowledge New Issues: If an email template is selected here, it will be used to generate auto-acknowledge emails when a new issue is created from an email. Acknowledge New Comments: If an email template is selected here, it will be used to generate auto-acknowledge emails when a new comment is added to an issue from an email. (error) | | ||
| Senders and Recipients | Sender Name Field: User Recipients: This attribute determines how the mail handler should treat users recognized as recipient email addresses:
Recipient field (To): The custom field selected here will be used to store email addresses of the email's TO recipients Recipient field (Cc): The custom field selected here will be used to store email addresses of the email's CC recipients | | ||
| Advanced Settings | Email Address Exclusion: Email addresses (one per line) entered here are not saved in the sender or recipient fields (useful to save the mail handler address here to avoid mail loops). Supports regular expressions, to ensure your email address exclusion will not run into problems. Include (?i) at the beginning of the email address for safety. Split Regex: Regular expressions (one per line) entered here are used to split the email body by a delimiter (optionally the original incoming email as well). See more details below. External Email Senders: Specify how to treat emails sent from email addresses not registered as users in Jira. Options are to accept the mails for processing or to ignore (leave in the mailbox) these emails. If you want to prevent the situation that practically anyone could pollute your Jira instance by sending emails, simply set this option to Ignore. Jira Mail Strategy: Specifies how to treat emails sent from the current or another Jira instance. Options are available to accept or ignore these emails.
Ignore Issue ID in Email Headers: By default, Email This Issue checks for the "In-Reply-To" and "References" email headers for Jira IDs if no issue keys appear in the email subject. If such an issue ID is found, it comments on the issue. By enabling this option you can override the default behavior and make JETI Email This Issue ignore these email headers. It can be useful to prevent confusion when an email sent from Jira is replied or forwarded back to Jira. In such cases, the seemingly unrelated issues may be commented on. If this checkbox is turned on, JETI Email This Issue will only use the email subject and its own Issue Lookup Field Rules to process emails but will ignore the invisible email headers. | |
...
Email This Issue Mail Handler supports regular expressions to split the email body into new content and original messages and import only the new content. See this page our tutorial and the Jira documentation for more details on this topic.
...
Split regex support works the same way as Jira's but JETI Email This Issue supports multiple expressions not only one expression.
...
| Note | ||
|---|---|---|
Split regex may match HTML tags in HTML emails. | ||
| Tip | ||
| ||
Email Processing Strategy
...
A fully configured mail handler example is this:
HTML Content Preserved with Inline Images
...
The transition to execute is identified by a transition property called jeti.on.email.transition. Add this property to the transitions in the statuses of the workflows, set its value to "true". JETI Email This Issue executes the first transition that has this property in the status the issue is in. You must also enable the "Execute transition" attribute in the Mail Handler:
Example Use Cases when to Use This Feature
Use Case #1:
JETI Email This Issue mail handler is processing an email that is associated with an Issue that is Closed. JETI Email This Issue besides adding a comment to the issue , may also execute a "Reopen" transition to reopen the issue for further investigation.
Use Case #2:
JETI Email This Issue is processing an email and creates a new issue in status Open, and after the issue is created it executes a transition to move the Issue to a new status called "Raised via email".
...
If you configure the Mail Handler in Jira Administration / Incoming Mails with the forwarding email option, then JETI Email This Issue will forward the skipped emails to this address.
The blacklist is maintained in the Configuration tab of the JETI Email This Issue Admin screen:
Fallback to Default Reporter
Email This Issue Mail Handler falls back to the Default Reporter when Jira users who send an email do not have permission to create or comment on the project. Jira would simply skip these emails, while JETI Email This Issue imports them with the default reporter. The default reporter is an appointed user account (real or technical) who is an agent on the project and has all the right permissions to create issues/ add comments.
Fire Event
Email This Issue Mail Handler can fire an event when it processes an email:
Example Usage:
- Define a custom event in Jira Administration, e.g. "Email Processed" (this is optional, you can use a system event too just like on the above image)
- Edit your Mail Handler Context and select "Email Processed" in the Mail Handler Event field
- Configure your JETI Email This Issue Event Notifications for "Email Processed" with recipients or have a custom Event Listener to react to emails.
Set Issue Fields from Email
...
- .
...