Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note
iconfalse

Summary

This guide is to explain how to customize the Email This Issue template that is used when you are manually editing and sending notifications using the Email button.



Info
iconfalse

Prerequisites

This tutorial requirethe following:

  • Email This Issue add-on installed in JIRA
  • A license key saved in JIRA
  • Have an SMTP server configured in JIRA

Note: You must be a Jira administrator to be able to perform the below settings.




Info
iconfalse

Objectives

By following this guide you will be able to carry out the following actions:

  1. Customize the email templates used by JIRA Email this Issue
  2. Associate the template with your projects and/or issue types



Step-by-step guide

In order to be able to send out customized email templates, you must follow the below steps:

  1. Customize the email templates used by JIRA Email this Issue

  2. Test your template settings (optional)

  3. Associate the template with your projects and/or issue types

Follow the below steps in order to customize an email template:

  1. Open the JETI Administration page and click on Email templates

  2. Click Add to add a template for your outgoing emails. This can be based on Themes or Jira event templates (e.g. Issue Created)
    Image Removed
    Image Added


  3. Customize the template according to your needs, use the field picker to add issue fields, custom fields, comments or issue linking information, etc. (e.g. call this template Custom Template)

  4. Click Save at the bottom of the page to save your template or click Cancel to discard the draft.

To create multiple email templates, repeat steps 1-4 as many times as needed.

Follow the below steps in order to test your template (optional):

  1. Open the JETI Administration page and click on Email templates

  2. Click on the three dots in the row of the template you wish to test and click Test:
    Image Removed
    Image Added

Follow the below steps in order to associate the template with your projects and/or issue types:

  1. Open the JETI Administration page and click on Contexts

  2. Click Add to add a new context and fill out the fields as below:

    Attribute nameDescription
    ProjectSelect the project you want to apply the context settings to. Leave the field empty to apply this context for all projects.
    Issue TypeSelect the issue type you want to apply the context settings to. Leave the field empty to apply this context for all issue types.
    TemplateSelect a default template for this context to use (e.g. the one you customized above, Custom Template). This template will be used when sending emails using the Email button.
    External Watchers FieldAdd external recipients as watchers to the issue.
    Sender Name Pattern

    Enter a name that appears in the emails as the sender. If left empty, JETI will use JIRA's default settings.
    Specify (in Velocity markup syntax) how to format the sender's name in outgoing emails.

    From Email Address

    Enter the email address you want to use as the "from address" in the emails. If left empty, JETI will use the default settings.

    Specify (in Velocity markup syntax) how to format the From Email Address in outgoing emails.


    To add multiple contexts, repeat step 2 as many times as needed.



Info
iconfalse

Content by Label
showLabelsfalse
max5
spacesPLUG
showSpacefalse
sortmodified
excerpttrue
reversetrue
typepage
excerptTypesimple
cqllabel in ("kb-how-to-article","tutorial","jeti") and type = "page" and space = "PLUG"
labelstutorial jeti kb-how-to-article