Mail Handler and Auto-reply emails
- Mail Handler
- Mail Handler Contexts
- Split Regex Support
- Email Processing Strategy
- HTML Content Preserved with Inline Images
- Execute transition on issues
- Fallback to Default Reporter
- Fire Event
- Set Issue Fields from Email
Auto-reply emails is a useful means in helpdesk and support systems to acknowledge the creation of a ticket from an email. Auto-reply emails in JETI are sent to the sender's email address. The emails may be created from a custom template, may contain attributes of the newly created issue - in the usual way in JETI.
To set up auto-reply emails you must use JETI's Mail Handler and define a corresponding Mail Handler Context.
In order to set up auto-reply emails, you must use Email This Issue Mail Handler to process the incoming emails. This mail handler is based on JIRA's Create Or Comment Handler. In addition to the default behaviour, it does two more steps:
- sends the auto-reply email, if enabled
- saves the sender's and recipients' email address in a custom field, so that it can be used later as a recipient of emails sent via the [Email This Issue Workflow post-function] or [Email This Issue Event Notificatons|Event Notifications]
Mail Handler Contexts
Mail Handler Contexts just like any other "Contexts" in Email This Issue are used to add configure in a flexible way depending on Project and Issue Type. You can define "broad" contexts that are applied to all projects and / or issue types.
Mail Handler Contexts are used in conjunction with the JETI Mail Handlers. If you set up the handler to create issues in project "MyProject" of type "Bug", there must be a Mail Handler Context that can be resolved to match this combination, e.g. a Mail Handler Context configured with project "MyProject" or type "Bug" or both.
Mail Handler Context Attributes
|Project||Project to which the context applies. If left empty, context applies to all projects|
|Issue Type||Issue Type to which the context applies. If left empty, context applies to all issue types|
|Email Processing Strategy|
Determines how Email This Issue Mail Handler processes the incoming emails.
There are various strategies available out-of-the-box:
All strategies also do the following (if configured to do so):
|Mail Handler Event||An issue event that is fired for each incoming emails that the mail handler processes.|
|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 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 email.|
This attribute deteremines how the mail handler should treat users recognized for recipient email addresses.
|Sender Field||Custom field selected here will be used to store email addresses of the email senders|
|Recipient Field||Custom field selected here will be used to store email addresses of the email senders|
|Copy Recipient Field||Custom field selected here will be used to store email addresses of the email senders|
|Email Address Exclusion||Email addresses (one per line) entered here are not saved in the sender or recipient fields|
|Split Regex||Regular expressions (one per line) entered here are used to split email body by a delimited. See more details below.|
Split Regex Support
SINCE VERSION 5.3.2
Email This Issue Mail Handler supports regular expressions to split email body into new content and original messages and import only the new content. See this page and the JIRA documentation for more details on this topic.
Multiple regular expressions can be entered in the Mail Handler Context.
Split regex support works the same way as of JIRA's but JETI supports multiple expressions not only one expression.
Regular expressions must follow Perl5 syntax.
An example regex that many users successfully use is:
Email Processing Strategy
SINCE VERSION 5.3.3
As written above If you configure Email This Issue Mail Handler in the Incoming Mail section of JIRA's Administration page, you must add a corresponding Mail Handler Context to fine tune your mail handler.
As part of this, you can now easily configure how Email This Issue Mail Handler should process the emails.
Currently supported Email Processing Strategies are:
- Create or Comment issues: Either a new issue or a new comment is created depending on whether an existing issue is recognized for the incoming email. This strategy supports split regex to prevent old content in the emails to be added.
- Always Create Issue: a new issue is created for each email
- Always Add Comment: a new comment is created if a matching issue is found, otherwise the email is not processed. This strategy supports split regex to prevent old content in the emails to be added.
HTML Content Preserved with Inline Images
Email This Issue Mail Handler retains the HTML layout and content of the incoming emails including inline images. Send an HTML formatted email to JIRA and see the original content and layout in the issue.
This feature works if the Issue Description and Comment fields are configured with the JEditor Renderer type. This requires JEditor to be installed and licensed properly in JIRA.
Execute transition on issues
Email This Issue Mail Handler executes a transition on the issue that is associated with the email that is being processed.
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 executes the first transition that has this property in the status the issue is in. Also you must enable "Execute transiton" attribute in the Mail Handler:
Example Use Cases when to Use This Feature
Use Case #1:
JETI mail handler is processing an email that is associated with an Issue that is Closed. JETI besides adding a comment to the issue, may execute a "Reopen" transition to reopen the issue for further investigation.
Use Case #2:
JETI is processing an email and creates a new issue in status Open, after the issue is created it executes a transition to move the Issue to new status called "Raised via email".
Email This Issue Mail Handler skips emails sent from blacklisted domains or email addresses. Item in the blacklist are regular expressions. If the sender's email address matches any of the regular expressions, the email is not processed.
If you configure the Mail Handler in JIRA Administration / Incoming Mails with forwarding email option, then JETI will forward the skipped emails to this address.
Blacklist is maintained in the Configuration tab of the JETI Admin screen.
Fallback to Default Reporter
Email This Issue Mail Handler falls back to the Default Reporter when JIRA users who send email do not have permission to create or comment in the project. JIRA would simply skip these emails, while JETI imports them with the default reporter.
Email This Issue Mail Handler can fire an event when it processes an email.
- Define a custom event in JIRA Administration, e.g. "Email Processed" (this is optional, you can use a system event too)
- Edit your Mail Handler Context and select "Email Processed" in the Mail Handler Event field
- Configure your JETI Event Notifications for "Email Processed" with recipients or have a custom Event Listener to react on emails.
Email This Issue Mail Handler allows you to fill issue fields (system fields and custom fields), execute workflow transitions from email content of the email.