Use Project Mappings

JEMHC Project Mappings allow fully-flexible Rule driven routing of email to projects.  This guide will describe JEMHC Project Mappings in detail, and provide examples to illustrate their use.

 It is not necessary to have a production mailbox setup to drive inbound issue creation,  JEMHC Test Cases can be used to inject an email into the processing pipeline.

Background

Profiles

A JEMHC Profile drives how incoming emails are handled in every detail, this includes the JIRA project that issues should be created in and much much more!

Default Project Mapping

When creating a Profile, the Profiles configuration is the default Project Mapping that applies by default when no other Project Mappings rules are either defined or match, as such, the default Project Mapping has no rules.

Rule Driven Project Mappings

When additional Project Mappings (for a given JIRA Project) are created, it is then possible to add Rules of several types that cause this Project Mapping to apply over other Project Mappings or the default.  When Project Mapping Rules are defined, for the most part, fields defined in the 'Default Project Mapping' are inherited by but can also be overridden by additional Project Mappings.

Rules

Rules can further override values defined in the related Project Mappings, allowing very flexible issue creation with full access to all issue parameters at that time.

Scenario 1 : Create a Profile

Create a basic Profile

1. Create a Profile:

   Open

   

    

2. Defining the "Catch Email Address" of your inbound mailbox, the target Project, and the IssueType:

   Open

   

3. See the new Profile, configuration of which is through the cog icon, it can also be copied, as well as exported (useful for support!) and deleted.
   
   

    

4. A summary of key information in the Profile, indicating defaults, can be seen by expanding the Catch Email Address

    

5. Use the Cog Icon to access the Profile, from here it is possible to edit some profile top level settings (1), and to gain access to the Project Mappings (2).

    

6. Accessing the Project Mappings will show just the default Project Mapping, the lack of rules is shown by 

   Configure the Project Mapping via the cog icon:
   
   

    

7. The Profile view shows the vertical nav that will take you to specific sections of the Profile, in the main panel view are summaries of each section, with a Pen icon, which also takes you to the edit view of the section:
   
   

    

8. To reinforce the 'default' nature of this Project Mapping, access the Rules link from the vertical nav:

Validate Profile handling

Validating expected outcome of email handling can be done quickly and easily with a JEMHC Test Case, where an 'email' can  be crafted with a valid TO: address that matches the "Catch Email Address" in the profile (your mailbox inbound address).

1. Create a Test Case:
   
   

    

2. Whats shown next is the platform neutral standards based format for a simple text email, select the profile created above (1), then  set the From: SMTP address (2) to be something valid, and the To: address (3) to be the Profile "Catch Email Address". Finally hit Submit to save (5):

    

3. The Created Test Case can now be run against the Profile it's associated with:

    

4. The Result of running a Test Case will show the Issue Key of the created issue, and some other info:

    

5. As custom fields already exist for 'Email Sender Address' and 'Email Participants' the resulting issue would look like:

Summary

In this scenario, all mail will end up in the given project, that's it.  For more flexible use of one profile to route mail to different projects, see following scenarios.

Scenario 2: Adding a Rule Driven Project Mapping

Once a basic Profile with default Project Mapping exists, adding a new Mapping for a new project that will route some mail to that mapped project, and all other mail to the default Project Mapping project. More information pertaining to Rules can be found here: https://thepluginpeople.atlassian.net/wiki/spaces/JEMHC/pages/3707895828.

Types of Project Mapping Rule

A project mapping rule can be made up of one or more of the following criteria:

From: address matching

A list of regular expressions that are used to match against the email sender address.  Note that this is matched against the email address part of the sender header, personal names are not considered.

eg:

Recipient (To:/Cc:) address matching

A list of regular expressions that are used to match against the email recipient address.  Note that this is matched against the email address part of the sender header, personal names are not considered.

eg:

Keyword matching

A list of strings that are used to match against text in the email subject or body (or both).

eg:

Create a new Project Mapping

1. In the Profile Project Mappings view, hit Create:
   
   

    

2. Set the Project and Issue Types, then hit Submit

    

3. This Project Mapping doesn't yet have any Rules, so will never be used, indicated in the post-Submit view -

   Use the Cog icon to configure the Project Mapping:
   
   

    

4. Here the Software Project Mapping is now available for configuration, all fields marked 

   will without further change, automatically take on the value defined in the Default Project Mapping (by the way, this is to minimize the amount of configuration that needs to be done!).  Access the Rules section now:
   
   

    

5. Initially, with no rules defined, again

    will indicate the Project Mapping wont be used, so hit Create to define one:
   
   

    

6. This will then create a new Rule. To Edit the Rule configuration options press the COG icon.

    

7. Then press Edit again to edit the criteria that defines a match. e.g. Keyword or address Regexp.

    

8. Rules can be created that match using regular expressions on the From or To (recipient) addresses defined in the email, as well as keywords, in this example, we'll map any sender from the @localhost domain with the regular expression .*@localhost (in regular expressions, * means any number of the preceding character not all characters, to match any character . is used, hence .* to match everything):

    

9. After submitting, the summary for the rule is shown:

Validate new Project Mapping

With this project mapping rule in place, any mail from @localhost will get handled through this Project Mapping, and be created in the TEST project

1. Create a new Test Case with a From: address of example@localhost and a To: address of the usual catchemail (incoming mailbox) address.  To do this, create a copy of the Test Case that was made earlier, using the copy option to get going:
   
   

    

2. Change the From: address for this case to example@localhost and Submit

    

3. After saving, run the new Test Case:

    

4. The Test Case post-execution result screen shows that an issue was created in the TEST project, and specifically, through the Rule:  Rule=Sender 'example@localhost' matches '.*@localhost'

   
   
   

Related articles