Welcome to Agilix Dawn!

How do I set up email templates in Dawn?

  • Updated:
    info_outline
    Created:

Dawn includes a variety of templated messages that are automatically sent to end users when certain actions or events take place to help administer the site. These messages can be customized and localized into the language of your choice.

For example:

When a potential learner is invited to create an account on your site, they receive an invite. By default, this message reads as follows (assuming your app is called "LoremLearning"):

You've been invited to LoremLearning!

The HTML that automates this message looks like this:

You've been invited to {{appName}}!  

There are two parts of this example message that we discuss in this document:

  • Message templates: You can edit any of the text in the Message template, so you could change it to read: We cordially invite you to join LoremLearing!, or simply Join us at LoremLearning!
  • Template variables: The text reading {{appName}} represents a Template variable. Dawn includes a variety of variables that you can insert into messages, and they will be replaced with information specific to your site; as seen above, variables are always enclosed in double curly braces.  

Use Message templates

Dawn's Message templates are specified as valid HTML with information text and Template variables. The following table outlines the default Message templates included in Dawn.

Name
Purpose
inviteUserTitle
This is the title text used when inviting a person to create an account in your system.

Default template: 
You've Been Invited to {{appName}}!
inviteUserMessage
This is the message text used when inviting a person to create an account.

This message should incorporate:
  •  The inviter variables described in the table below to personalize the message. 
  • The inviteURL variable, so the learner can use it to join.
Default template: 
{{inviteeGivenName}} {{inviteeFamilyName}},

I created an account for you on {{appName}}. Click the link below to set your password and get started.

<a href='{{inviteURL}}'>Get Started</a>

If you have any questions about this invitation respond to me at {{inviterEmail}}.

Enjoy,
{{inviterGivenName}} {{inviterFamilyName}}
createAccountTitle
This is the create account email confirmation message.

Default template: 
Create account
createAccountMessage
This is the title text for the create account email confirmation message.

The message must include the resetToken for the email confirmation message to be usable.

Default template: 
Create account

This message is in response to a request to create an account. If you did not make that request, then simply ignore this message. Otherwise, use the following token in the create account prompt.

{{resetToken}}

resetPasswordTitle
This is the title text for the reset password email confirmation message.

Default template: 
Reset password
resetPasswordMessage
This is the title text for the create account email confirmation message.

The message must include the resetToken for the reset password message to be usable.

Default template: 
Reset password

This message is in response to a request to reset your password. If you did not make that request then simply ignore this message. Otherwise use the following token in the password reset prompt.

{{resetToken}}

Example HTML file

In a scenario where Maria Chan were to invite a student named Jay Campbell to join a course in LoremLearning, the inviteUserMessage shown above would look like this:

Jay Campbell,

I created an account for you on LoremLearning. Click the link below to set your password and get started.

Get Started

If you have any questions about this invitation respond to me at Maria.Chan@email.email.

Enjoy,

Maria Chan

Use Template variables

As discussed above, Template variables can be used in Message templates to customize and personalize the delivered messages based on context and the users involved.

The following table outlines the variables you can use.

Variable Purpose
appName
This variable inserts the application name you’ve chosen.
inviteeGivenName
This variable inserts the given name of the person receiving the message.
inviteeFamilyName
This variable inserts the family name of the person receiving the message.
inviteURL
This variable inserts the URL that allows the invitee to accept the invitation.
inviterEmail
This variable inserts the email of the inviter.
inviterGivenName
This variable inserts the given name of the person generating the message.
inviterFamilyName
This variable inserts the family name of the person generating the message.
resetToken
This variable inserts the token used to complete the account interaction.
forum

Have a question or feedback? Let us know over in Discussions!