JEMH Hint Notifications

Owned by Finn Gale
Last updated: Oct 26, 2022
3 min read

Summary

When JEMH processes emails, if things don't quite work as expected, for example, security constraints stop an 'edit' operation, rather than swallow that, these kinds of things are collated and sent via formatted email back to the sender. The intention is to help users figure out what they did wrong.

Hint Notifications/Hint-O-Grams have been present in JEMH since version 1.0.0. This page covers the use of Hint Notifications in our current release series (3.x and 4.x).

Configuration

 

Configuration

Description

Configuration

Description

Hint-O-Gram enabled?

Checkbox for enabling Hint Notifications

Override Hint-O-Gram email address

Defines a target email address for Hint Notifications to override as the sender, allowing a specified address to receive Hint Notifications rather than the email sender

Notify Sender of Forward Since 3.4.0Since 4.0.12

Allows Hint Notifications to be send for ‘Forward' issue creation outcome. Please note, this will increase outbound traffic.

When are Hint Notifications sent?

Reject Scenarios

On Create
On Comment

  • If the sender is not already involved on the issue and the ‘Non JIRA account holder Security Check filter’ is enabled

  • A script manually sets the processing Outcome

  • The email sender is Blacklisted, and the blacklist outcome is set to Reject

Notify of Forward Since 3.4.0Since 4.0.12

JEMH can send notifications to the email sender when issue creation results in a Forward status (subject to some restrictions). This can be used to let the sender know their email was handled but no issues were created, and that a member of your team has been notified and will address any issues. This notification hint uses the same template as the Hint Notification.

When is the Sender notified?

The email Sender is notified for all email processing which results in a ‘Forward’ Processing outcome, except when:

  1. The Message is filtered due to an X-Jira-Fingerprint header. This is to prevent mail loops, see here for more details:

    1. https://thepluginpeople.atlassian.net/wiki/spaces/JEMH/pages/2850924

  2. When the email does not contain a valid sender address

  3. When Email Processing finds a target issue for commenting, forward hint notifications should only apply on create. For comment based hint notifications see:

    1. https://thepluginpeople.atlassian.net/wiki/spaces/JEMH/pages/70254738

Hint Template Updated 3.4.1Updated 4.0.12

As part of changes to Hint Notifications, the Default Notification Template provided by JEMH has been updated. This will not affect existing custom Hint Templates. To summarise the changes:

  1. Notification template is split into Reject/ and Forward sections to show different content based on the outcome of email processing

  2. Reject Notifications show a limited version of the JEMH Processing Report. This was done to which includes the following report sections:

    1. Outcome

    2. Hints

    3. Filters

  3. Forward Hint Notifications show no Processing Report content by default

  4. Forward Hint Notifications no-longer provide the Jira Admin’s address as a point of contact by default

  5. HTML Notifications have been updated visually, see: