Templates

Owned by Maria Fakas (Deactivated)
Last updated: Oct 11, 2024 by Jakub Gladykowski
6 min read

Create great-looking emails to match your company looks in the drag-and-drop template editor. Whether you need to include custom fields or non-issue fields, add some text to explain why a recipient is getting a notification, customize your email.

To send email notifications, you can use three types of email templates: Single Issue Template, Table Template, or Comment Template. You create a custom one as well. To set up your email template, go to your project settings, and click on the “NAFJC Templates“ tab, or configure one at the Global templates level.

 

Templates can have 3 types of scope

  • NAFJC Native - These are Templates that we created and can not be edited by a user.

  • Global - These are created by a Jira administrator and can be used in any project. They can not be edited by a project admin.

  • Project - These are created by a Project administrator and can only be used in the project in which they were created. An administrator can convert a templates from the Project Scope to the Global scope from the … menu in the Global templates page by clicking the Move to system template option.

Templates

We provide 3 out-of-the-box Templates. Use the Single Issue Template theme for a Jira (Core, Software, or Service Management Agent) notifications. The Table Template theme helps you show a list of notifications in one email. With the Comment Template, you can display an issue and its comment in the email notification. Customize any of these themes in the template editor to create the notification email you need.

  1. Table Template. Use this type of default email template to notify recipients and provide the information on the long list of issues. An example of a customized “Table Template” email theme:

     

  2. Single Issue Template. This theme is applied to include a one-issue notification. The email based on the Single Issue Template theme provides the user with the relevant information from the issue. An example of a customized “Issue Details” email template:

     

  3. Comment Template. Send comment notifications that include the most relevant information in your email. Apply the Comment Template to your triggered notification. An example of a customized “Comment Template” email theme:

You can find all these template themes in the NAFJC Templates tab. To use the necessary template theme, click on the three dots next to the template theme you need to use and Duplicate. You’ll create a “Copy of….“ template. Open it, edit and save.

Block Section

To expand these pre-defined templates, you can add the following blocks to customize your emails.

Issue field. You can add the issue field block in pre-defined email templates or/and insert them into the text. In this case, the issue fields you inserted will be substituted with the related issue field's value. After you drop an issue field into the content-box, you should select it and go to the Settings to set up the Field Name.

Non-issue field. This field isn’t related to an issue but related to a notification. Use non-issue fields to add things like the recipients full name into an email message, email footer, or any other custom text block. Please do not add any non-issue fields to the issue block.

Loop block. If you need to iterate the values of some fields, add them to the Loop block. We do not recommend using the Loop block with prepared email templates.

Section Block(s)

Section blocks. Use the Section blocks to split up content on the sides of the screen. We currently support the following ratios:

  • 1/2

  • 3/4

  • 1/3

Image Block

Image block. Add an image to the email template. We currently support only remote images hosted via HTTPS.

Text. Add a text section to your email. Customize only a part of the text from the block section by selecting it and using the text editing menu, which appears next to your selected text.

Text section. Add a text block, that includes a heading and simple text section.

Divider. Add a divider to your email template. Apply styles to make it yours.

Email footer. Customize your footer to let your recipients know the reason why they get their notifications. It's fully customizable and may include issue and non-issue field, text, link, or divider.

Single issue. Include a block with issue details in your email template. No header or footer is included. Configure issue fields depending on your notification requirements.

Issue table. Similar to a Single issue, Issue Table but makes it easier to read the list of Jira or JSD issues in one email for the recipient. Configure issue fields depending on your notification requirements.

Link. Add a link as a separate element to your content box.

Styles

Apply all the styles to a specific Class. The class applies to a block section. If you need to customize separate words in the text, click twice on the text to display the editing menu.

  1. Classes. Control which classes you apply to any of your blocks.

  2. Dimension. Set up sizes, margin, and padding for your blocks.

  3. Typography. Customize font family, size, weight, letter spacing in a Typography section. Apply colors to your text (provide a color number, or pick it from the color palette). Specify the alignment of text in an element.

  4. Decoration. Set up background color and border for your element, specify border-radius.

Settings

Element Attribute Configuration

Issue field. In the Setting section, you can choose a name for the selected issue field.

Non-issue field. Select a Field Type for the non-issue field in settings. If you add a link to this element, you can also provide a page URL and Target page.

Link. Title Url Target

Picture. Provide Alt text in the settings for the images in your email template.

Text block. You can add Id and Title for the text block.

Functional Panel

On the left side of the functional panel, you can get a preview of your email template for a desktop, tablet, or mobile. You can also view components to highlight the structure of your email template. It helps you to configure elements and makes it more convenient to apply styles to them.

Export and Import buttons allow you to save the HTML code of a created email template or upload your personalized one. Please, note that you can’t edit your code after you import it to the Template Editor.

Undo or Redo your actions. Use the Clear button to remove all the elements or imported email templates from the Content Box. 

Placeholders

We support advanced configuration using placeholders. Please see the docs at Placeholders