Workflow post functions

Email This Issue has workflow post functions to send fully customizable emails as part of the workflow transitions. Sending emails from transitions can be a better alternative to event notifications, because specific operations, such as Request Approved might not be precisely represented by generic event types such as Issue Updated.

To see the list of current post functions, go to the Outgoing Mails configuration tab and select Workflow Post Functions under GENERAL CONFIGURATION.

Adding a post function to the workflow

Email post functions must be added and edited in the workflow editor of Jira.

1. Select Issues in the Settings menu, then go to Workflows under the WORKFLOWS section of the sidebar.

2. Choose the workflow that you want to add the post functions to and click View under the Actions column.

3. Switch to Text view to display the Transitions (id) column, then click on the chosen transition.

4. Switch to the Post Functions tab of the selected transition and click Add post function.

Consider the following during setting up a post function:

  • Scope - WHEN

  • Recipients - WHO

  • Content Settings - WHAT

Setting up Scope - WHEN

Setting a JQL filter makes it easy to better target the issues and send emails conditionally depending on the issue fields. The following example emails are sent only when the issue is of the Highest priority.

To enter a JQL that involves a user name (such as defining the assignee of an issue), follow these steps:

  1. Under the JQL Filter field, click Edit.

  2. Enter the JQL filter.

  3. When it comes to entering a user name, do the following:

    1. Click Insert user.

    2. Search for the user name, then click Insert to insert a string.

  4. Click Save to use the JQL filter or Cancel to delete it.

Setting up Recipients - WHO

Recipients selected in the post function will receive the emails.

Emails can have To, Cc and Bcc recipients. For all of these recipient types, you can enter or select:

  • Users from Jira

  • Email addresses

  • Users related to the issue or project, such as:

    • Assignee

    • Reporter

    • Watchers

    • Project Lead

    • Current User

  • Project roles

  • User groups

  • Custom fields that hold email addresses or users or groups

Setting up Content Settings - WHAT

Content settings in Email This Issue Post Functions specify the email template to use, and additional content that will be added to the email.

Content settings attributes include:

Template

An Email This Issue template

The template selected here will be used to render the subject and body of the final email.

Subject

Text to be added to the email subject

Text entered here is combined into the final email's subject using the template above.

The template's $!mailSubject variable renders the entered value in the email subject.

Message

Text to be added to the email body

Text entered here is combined into the final email's body using the template above.

The template's $!mailBody variable renders the entered value in the email body.

Attachments

Attachment policy

The value selected in this field determines which issue attachments should be attached to the email.

The options are the following:

  • all: all attachments added

  • none: none of the attachments added

  • added in the last operation: attachments added as part of the operation that fired the event (e.g. Edit Issue)

  • newest versions of all: newest version of all attachments. Attachments with the same name are considered to be versions of the same attachment.

  • added recently: the latest added attachments.

Note: Jira Email This Issue doesn't receive any list about the added attachments. To figure out the latest added attachment, Jira Email This Issue asks for all the attachments of the issue and send only added at the last minute from the latest one.

  • the newest attachment(s) in the issue: the last added attachment(s)

You can configure the policy to filter internal attachments. When this option is enabled and the issue is in a Service Management project, attachments added in internal comments won't be included in the email.

Email Format

HTML or TEXT

The format of the email.

Note: It is perfectly valid to add multiple Email This Issue post functions to the same transition; they will be called one after the other.

Important: Post functions must be moved down before or after the function firing the event. This is needed because Email This Issue expects the issue to be updated and fully indexed before rendering issue fields in the email.

Last updated