Pre-Processing
- 1 Enabling Pre-Processing
- 2 Configuration
- 2.1 Content Type Preference
- 2.2 Forwarded Email Subject Prefixes
- 2.3 Pre Field Processor Subject Clean-up Regexes
- 2.4 Pre Field Processor Body Clean-up Regexes
- 2.5 Create Body Delimiter Texts
- 2.6 Create Body Delimiter Regexes
- 2.7 Create Post Field Processor Body Clean-up Regexes
- 2.8 Comment Body Delimiter Texts
- 2.9 Comment Body Delimiter Regexes
- 2.10 Comment Post Field Processor Body Clean-up Regexes
- 2.11 Sent Date Field
- 2.12 Sent Date Field Format
- 3 Issue Association
- 3.1 Issue Keys In Subject
- 3.1.1 Subject Issue Key Regex
- 3.2 Email Threading
- 3.2.1 Use References Header
- 3.2.2 Use In-Reply-To Header
- 3.3 Associate Issue by foreign key
- 3.3.1 Sender Regexes
- 3.3.2 Foreign Key Source
- 3.3.3 Foreign Key Regex
- 3.3.4 Issue Status
- 3.3.5 Foreign Key Field
- 3.1 Issue Keys In Subject
- 4 Message Rejection
- 4.1 Reject Comment On Status
- 4.2 Reject comment on JQL Match
- 4.3 Reject Comments When Issue Resolved For More Than Days
- 4.4 Issue creation on Comment Rejection Match
- 4.5 Notify Sender When Issue Cannot Be Created
- 4.6 Notify Sender On Comment Limit Exceeded
- 4.7 Notify Sender When An Issue Creation Is Rejected Due To 'Comment Only' Mode
- 4.8 Notify Sender When Cannot Comment Due To Not Being Involved
Before processing the incoming email, JEMH Cloud allows pre-processing tasks that can edit or fix the incoming email content.
Enabling Pre-Processing
The Profile will show “Use Reprocessed Message” not enabled by default:
Edit the Profile section and enable “Use reprocessed Message” to be able to see and enable available Pre-Processing tasks:
Configuration
This section describes how email content should be manipulated before processing issue create and comment requests.
Content Type Preference
The selected option will be the preferred format for processing when emails contain both ‘text’ and ‘html’ bodies.
Available options are:
HTML - The ‘html’ part will be processed.
Text - The ‘text’ part will be processed.
Any - No preference.
Forwarded Email Subject Prefixes
The regex values provided will be used to filter incoming email subject prefixes. If a subject prefix matches the provided regex, the prefix will be removed from the email subject.
Pre Field Processor Subject Clean-up Regexes
Custom regexes supplied will be used to match against and remove matching content from the incoming email subject. This can be used to remove sensitive data in email subjects not wanted in the issue summary.
Pre Field Processor Body Clean-up Regexes
Custom regexes supplied will be used to match against and remove matching content from the incoming email body. This can be used to remove sensitive data in the email body not wanted in the issue description for created issues (or comment for issue update comments).
Create Body Delimiter Texts
Custom regexes configured here will be used as body delimiters when creating an issue.
Create Body Delimiter Regexes
These predefined regexes can be applied against the email body when creating issues. (Holding Ctrl
and selecting another value allows you to select multiple predefined regexes).
Create Post Field Processor Body Clean-up Regexes
Regexes defined here will run after Field Processors (See https://thepluginpeople.atlassian.net/l/cp/gj1HBWb1). Custom regexes configured here will be used as body delimiters when creating an issue.
Comment Body Delimiter Texts
Custom regexes configured here will be used as body delimiters when commenting on an issue.
Comment Body Delimiter Regexes
These predefined regexes can be applied against the email body when commenting on issues. (Holding Ctrl
and selecting another value allows you to select multiple predefined regexes).
Comment Post Field Processor Body Clean-up Regexes
Regexes defined here will run after Field Processors (See https://thepluginpeople.atlassian.net/l/cp/gj1HBWb1). Custom regexes configured here will be used as body delimiters when creating on an issue.
Sent Date Field
The selected custom field will be used to store the ‘sent date’ value found within an incoming email.
Sent Date Field Format
The format pattern provided will be used when setting the ‘sent date’ field.
Default format is: dd/MMM/yy h:mm a
. The default format will be used if this setting is left empty.
Issue Association
Issue association allows incoming emails to be matched against an existing Jira issue, allowing comments and other issue update events to be performed against the issue.
Issue association strategies are run in the following order:
Issue key Directive. For example,
@issueKey=ABC_123
Issue key/custom field comparison Directive. For example,
@issueKey=someCustomField=EXT_ABC
JQL issue key Directive. For example,
@issueKey=JQLStatement
Foreign key association via regexp match, or first capture group. For example,
([A-Z]{12})
Issue key in subject. For example,
Re: ABC-123
Original Message ID to issue association. For example,
References: ORIGINAL_MESSAGE_ID
Threading values in headers. For example,
In-Reply-To/References: <JEMHCloud.ENV.ISSUE_KEY@HOST_URL>
Issue Keys In Subject
When enabled, JEMH Cloud will look for valid issue keys found in the incoming email subject.
Subject Issue Key Regex
The regex provided will be used when searching for issue keys in the incoming email subject. Only applicable if ‘Issue Keys In Subject’ is enabled.
Email Threading
JEMHCloud can check the References and In-Reply-To header value(s) for a Message-Id that matches an existing issue. The found issue (if applicable) will be used as the associated issue when processing the incoming email.
Use References Header
When enabled, email threading will be attempted by checking the References
header of the incoming email. Only applicable if Email Threading is enabled.
Use In-Reply-To Header
When enabled, email threading will be attempted by checking the In-Reply-To
header of the incoming email. Only applicable if Email Threading is enabled.
Associate Issue by foreign key
Issues can also be associated by a foreign key value. When enabled, any matching foreign keys in the incoming email will be used to find a matching issue.
Sender Regexes
The provided values are used to enable foreign key associations. If one of the comma separated values (E.g. sender1@company.com, sender2@company.com
) matches against the sender of an incoming email, JEMH Cloud will attempt foreign key association.
Foreign Key Source
The location used to search for foreign keys in the incoming emails. Available options are:
Subject - Looks for foreign keys in the email Subject.
Body - Looks for foreign keys in the email Body.
Foreign Key Regex
The regular expression used to locate a foreign key from the incoming email. (E.g. (ABC+[0-9]+)
to extract the value ‘ABC123’)
Issue Status
The selected statuses will be used to filter searched issues that match a found foreign key.
If left blank, any non-resolved issues will be searched.
If ‘Any status’ is enabled, all issues will be searched for matching foreign keys.
Foreign Key Field
The field selected will be the chosen field JEMH Cloud looks at when finding matching foreign keys on existing issues.
Message Rejection
Message rejection configuration allows incoming emails to be rejected when attempting to comment on existing issues matching the following criteria.
Reject Comment On Status
Any statuses selected will be checked against the associated issue. If the issue matches one of the statuses provided, the comment from the incoming email will be rejected.
Reject comment on JQL Match
The JQL value provided will be used to check against associated issues. If the JQL provided matches the associated issue, the comment from the incoming email will be rejected.
When empty, comments will be allowed on associated issues regardless. See JQL for further information on configuring your custom JQL.
Reject Comments When Issue Resolved For More Than Days
The numeric value entered will be used to reject comments from incoming emails if the associated issue has been resolved for more than the specific amount of days. If the value is left blank, comments will be allowed on issues that have been resolved regardless of the resolution date.
Issue creation on Comment Rejection Match
A new issue will be created when an email is rejected for attempting to comment on a issue that matches the above criteria.
Notify Sender When Issue Cannot Be Created
When enabled, notify the sender of an incoming email when issue creation fails. For example, if a required Jira field or Custom Field has no value set as default, the issue creation will fail due to not providing a value for the required field.
Notify Sender On Comment Limit Exceeded
When enabled, notify the sender when an incoming email attempts to add a comment to an issue that has reached the allowed comment limit. (If disabled, the sender will not be notified, but the comment will still fail due to comment limit being exceeded). (See Profile Configuration | Comment Count Limit ).
Notify Sender When An Issue Creation Is Rejected Due To 'Comment Only' Mode
When enabled, Notify the sender when it tries to create an issue from an incoming email when the operating mode is 'Comment Only'. (See Issue configuration | Operating Mode ).
Notify Sender When Cannot Comment Due To Not Being Involved
When enabled, notify the incoming email sender when either:
The sender is a Jira user without permission to comment on the associated Issue.
The sender is an email only user but is not included in the email only custom fields.