About email templates

You use email templates to create the body of an email message. Typically, email templates are generally suitable only for boilerplate text that does not require modification, or, for presenting in the application interface as the starting point for further modification. However, email templates do support Gosu expressions, both in the Subject string, and in the Body string. It is also possible for an email template to be in HTML-formatted text. However, you cannot use Email templates for mail-merge types of operations.

By default, email templates live in the following location in Studio:

configuration > config > resources > emailtemplates

Email template files

An email template consists of two separate files:

  • A descriptor file that contains some metadata about the template. The file name must end in .gosu.descriptor,
  • A template file that contains the desired contents of the email body. The file name must end in .gosu.
Important: The file names of the descriptor and template files must match.

An email descriptor file contains the following fields:

Field

Description

body

The email body of the emails created using this template

keywords

A list of keywords for use in searching the templates

name

The name of the template

subject

The email subject of the emails created using this template

topic

The topic of the template

For example, EmailReceived.gosu.descriptor defines an Email Received descriptor file:

<?xml version="1.0" encoding="UTF-8"?>
<serialization>
  <emailtemplate-descriptor
    name="Email Received"
    keywords="email"
    topic="reply"
    subject="Email Received"
    body="EmailReceived.gosu"
  />
</serialization>

The EmailReceived.gosu.descriptor file pairs with the actual template file (EmailReceived.gosu):

Thank you for your correspondence. It has been received and someone will contact you shortly to follow up on your feedback.

Sincerely,