Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3

Welcome!

HiHello! This guide will take you through all the configuration necessary to setup JEMH for Jira Cloud (JEMHC). This will take 20 - 35 minutes depending on what you need.

...

  • An active Jira Cloud instance that you have administration rights for

  • For inbound email processing:

    • A valid Jira project

    • An external (non-Atlassian) mail source, for example a POP or IMAP server visible by JEMHC - Setup JEMHC Inbound mail (typically through a cloud provider like O365, Gmail, but could be your own).

  • For outbound email notification:

    • An external (non-Atlassian) SMTP mail server.

...

After confirming, JEMH will then be installed.

...

Once installation is completedcomplete, click use the Get started link . This will bring you to the open JEMH Cloud startup wizard, which will assist you with creating a basic configuration.

...

Later, this wizard can be revisited via a link on the Welcome page. For the purposes of this guide, we will 'll choose to configure both inbound processing and outbound aspects of JEMHC. You can choose what is best for your needs.notifications.

Setup inbound mail processing

You will likely need to whitelist the JEMHC application IP address for access to your mailservers:

...

If your mail server has a firewall or other IP based security, you may need to configure it to allow the app’s public IP address so we can access your mail servers:

  • JEMH Cloud public IP address : 54.210.55.45

...

Note

Always ensure that access your mail server is adequately secured!

Next we will configure JEMHC to process emails retrieved from an incoming mail server. Firstly, we will select our first a project that emails should create issues in. Do not worry, later Later on you can add additional projects to the configuration - this is just for initial set up. You will also be asked for an issue type.

...

Next, we will we’ll set up our inbound mail server connection. Selecting Create new message source will allow you to specify your mail server connection detailssettings. Alternatively, if you are you’re connecting to a Google or Microsoft email account via OAuth, you can use the respective sign in buttons. See Integrate with Gmail using OAuth and Integrate to Office365/EWS with Microsoft 365 using OAuth for more information.

...

For the purposes of this guide, we will 'll select Create new message source and connect to an example POP3 mail server. JEMHC provides some standard presets. You can choose Custom to pick your own specific hosts and ports, but its it's on you to ensure it is 's correct!

...

Expand
titleCreate Message Source configuration assistance

Setting

Description

Name

Name of the message source

Type

Message source type

Preset

Presets which can be used to simplify the remaining configuration i.e. Host/Post

Host

Message Server's hostname or IP Address

Port

Message Server's port

Timeout

Connection to be timed out based on the configured time (seconds). Leaving this configuration blank would result the timeout to be 30 second

Username

Username to access the account

Password

Password to access the account

SSL

Does the connection use SSL?

SSL Certificate Validation

SSL Certification Validation

Check Server Identity

RFC 2595 specifies additional checks that must be performed on the server's certificate to ensure that the server you connected to is the server you intended to connect to. This reduces the risk of 'man in the middle' attacks.

Read Strategy

Read Unread and Mark As Read - Only the unread emails in the mailbox are to be processed and once read, they will be flagged as read (Default). 

Read All and Delete - All the emails in the mailbox will be read and deleted after they are successfully processed.

NOTE:

  • You should be fully aware of the changes you make when switching between strategies as it can potentially impact your allowance.

For example: UserA has been using Read Unread and Mark As Read read strategy for past 5+ months and currently has over 2000 emails residing in the inbox. However, the user has now decided to switch the read strategy over to Read All and Delete and the consequence of this turned out that all the mails residing in the inbox folder were processed by JEMHC which resulted to exceeding the allowance. 

  • Potential impact - POP Mail Server configuration may override the instructions given by JEMHC.

For example: read strategy (in JEMHC) has been set to Read Unread and Mark As Read and the Mail Server (POP) has been configured to Delete Gmail's copy once it has been processed. The end result of this would be the processed mail will be deleted from the inbox as per configuration.


Once the server details have been entered, click the Test configuration button to validate the connection. If the connection is valid, you will receive feedback it's valid, you’ll see a message similar to the below:

...

If you are 're using Google Mail you may see the following messagea warning. If this happens, follow use the link in the message and do as describedfollow its advice.

...

Submit the connection settings once they have been successfully validatedare valid. Lastly, JEMH will ask you you’ll be asked to enter the Inbound email address. Typically this would be is the username used in the inbound mail server connection.

...

Click next to move on to the next wizard section.

Setup Custom Fields

In order to support email integration for users with no Jira user account, JEMHC needs to store email addresses in custom fields, so that these non-Jira users can be notified later. On this screen, we can select . Select what custom field is used to store a non-Jira email sender's name and address. We You can also choose what custom field is used to store non-Jira where additional user email recipients (CC and BCC) are stored.

...

If JEMHC warns you see a warning that a field is not isn’t present on the projects issue screen (as above), click the link in the message. You will then be able to associate the field with the appropriate screen related to your project

...

Repeat this process until all 3 custom fields of your choice are showing the status as "found" in the wizard.

...

Click next once this is done. Finally, JEMHC will present you with you’ll see a brief summary of the changes that will occur. Clicking submit here will complete the wizard.

...

On the final screen, you are given some suggestions of what to do next. If you would like want to be taken go to the JEMH welcome screen at this point, click Go to configuration.

...

Until the mail server setting has been used, its status will be 'unknown'.  To validate this, use the POLL poll action to send a test mail as before:

...

Outcome test. Here, the outcome is that the SMTP server status is now Online (this would have happened anyway on first actual usage):

...

  1. The credentials supplied in JEMHC > Workarounds > User Lookup must have the Jira Global Permission BROWSE_USER, inherited through a group membership.

  2. The related user must also be in the Administrator role in the project, typically, this would mean a user in the administrators group.

  3. The related user must also have Application Access in order to look up issues in the Lookup User Tester.

...

  • Within Jira User Management press "Create User"

  • On the screen that follows, enter a valid email address, username and full name. To avoid creating an email account for the setup of the workaround user, you can set the email address as an aliased address of your own email account. With an example email account of yourusername@gmail.com you could use yourusername+workaround@gmail.com where "workaround" is the username of the created workaround user. Using the +workaround address will create a unique address for the workaround user that will actually be an alias of your own email account. Emails sent to the +workaround user will arrive in your inbox.

  • Within the "Additional Options" sub-menu, make sure "Send invitation email" is ticked.

  • Press "Create User"

  • An email will now be sent to the email address defined in user creation, click the link in the email to activate the account and set a password for the user.

  • User account is now created and can be configured as the workaround user.