Email Template Administration

Overview

The Email Template Administration page lets you manage your environment's system-generated email messages. You can customize the subject line, body text, and formatting using simple HTML HTML (Hyper Text Markup Language) is the standard markup language for for achieving font, color, graphic, and hyperlink effects when creating web pages. or Nunjucks Nunjucks is a flexible JavaScript templating engine that supports template inheritance, filters, and logic-based expressions for dynamic content rendering. templating. This gives you flexibility to tailor messages to your application's branding and tone.

Example messages include:

You can update the wording, styling, and logic behind these messages directly in the administration settings. You can also customize the logic behind the Password Reset process. When an end-user clicks Forgot Password on the login page, they receive a default email linking them to Unqork’s standard password reset screen. You can create a custom password reset module instead and link to it from the Email Template Administration page. Once configured, your custom reset experience displays when the end-user receives the reset email.

Accessing the Email Template Administration Page

Begin by navigating to the Email Template Administration page.

To do so, follow these steps:

1. At the top right of the Unqork Designer Platform, click Administration.
2. Under Environment, select Email Template Administration.

A static image displaying the Email Templates Administration Page.

On the Email Template Administration page, you'll see the following email templates listed:

Email Template

Description

Invitation

This email is sent when you add an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. to your environment, either as an Express or Designer user. It includes a welcome message and a temporary password for first-time login. The temporary password is valid for seven days.

Forgot Password

This email is sent to end-users who click Forgot Password when trying to log in to Unqork. The body of the email has a link where the end-user can reset their password. This link expires in seven days.

Added to Workspace

This email notifies a Creator Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. that they have been added to a workspace in Unqork. The email contains a confirmation message confirms the granted access, with a link directing the Creator to log in and open the workspace.

Account Locked

This email is sent to the Creator when their account has been locked due to too many failed login attempts. This email includes an explanation about why the account was locked and possible next steps to unlock it.

Token Invitation

This provides an invitation to create an account using a token. This email includes a personalized message, a token-based registration link, and an expiry timeframe for security purposes.

User Profile Changed

This email alerts Creators that a change was made to their profile. The email includes a message confirming the profile update, a summary of updated fields, and instructions on how to contact support if the change was not made by the Creator.

Using Nunjucks Variables to Personalize Emails

You can format your emails using simple HTML HTML (Hyper Text Markup Language) is the standard markup language for for achieving font, color, graphic, and hyperlink effects when creating web pages., or customize them further with Nunjucks Nunjucks is a flexible JavaScript templating engine that supports template inheritance, filters, and logic-based expressions for dynamic content rendering.. Nunjucks variables let you personalize email content for each recipient. These variables adjust the message based on the selected input, making communication more relevant. The following table outlines available Nunjuck variables, and how to use them effectively.

Email Template

Nunjucks Variable Option

Invitation

Your Nunjucks variable options for the Invitation template are username and password. Each variable must be inside curly braces ({{}}) for Unqork to populate it with the correct user information. To use these variables, enter {{username}} or {{password}} in the body of your text. When the email is sent, Unqork replaces the variables with your user's username and password.

At a minimum, you must include {{password}} in the template for it to save.

Forgot Password

Your Nunjucks variable option for the Forgot Password template is url. Again, the variable needs to be inside curly braces ({{}}) for Unqork to populate the correct information. To use this variable, enter {{url}} in the body of your text. When the email is sent, Unqork replaces the variable with the URL A URL (uniform resource locator) is a unique identifier used to locate a resource on the internet. Also known as a web address. for your user to reset their password.

At a minimum, you must have {{url}} in the template for it to save.

Added to Workspace

Your Nunjucks variable option for Added to Workspace template is workspaceName. The variable must be inside curly braces ({{}}). To use this variable, enter {{workspaceName}} in the body of your text. When the email is sent, Unqork replaces the variable with the workspace name and notifies the user, that they have been added to a workspace.

At a minimum, you must have {{workspaceName}} in the template for it to save.

Token Invitation

Your Nunjucks variable options for the Token Invitation template are the following:

  • url: Selects the host URL that can be req.host or req.headers['x-req-host']. The variable must be inside curly braces ({{}}). To use this variable, enter {{url}} in the body of your text. When the email is sent, Unqork replaces the variable with the URL to create an account.

  • durationHours: This variable must be inside curly braces ({{}}). To use this variable, enter {{durationHours}} in the body of your text. When the email is sent, Unqork replaces the variable with the number of hours the token is valid for. For example, This invitation will expire in {{ durationHours }} hours..

At a minimum, you must have {{url}} in the template for it to save.

Here's an example of how an HTML and {{url}} Nunjucks Nunjucks is a flexible JavaScript templating engine that supports template inheritance, filters, and logic-based expressions for dynamic content rendering. variable looks in a Forgot Password email:

And here's what that Forgot email looks like to your end-user:

Customize Your Email Templates

You can customize the default email templates based on your requirement using HTML HTML (Hyper Text Markup Language) is the standard markup language for for achieving font, color, graphic, and hyperlink effects when creating web pages.. This lets you fine-tune the subject line and body content that reflects your tone, include styled text, or add branding elements.

To edit an Invitation email template:

1. Navigate to the Email Templates Administration page.
2. Locate the Invitation template and click Edit.

3. Update the Subject and Template fields based on your requirements.
4. Adjust the font size, formatting and layout using HTML HTML (Hyper Text Markup Language) is the standard markup language for for achieving font, color, graphic, and hyperlink effects when creating web pages., and add images for branding.

5. Click Save Changes.

You can edit the other email templates by following the same process.