About Message Templates

Message Templates are reusable content structures for preparing email messages sent to participants within the CO. Message Templates use Substitutions to allow for personalization and inclusion of context.

Defining Message Templates

Message Templates are managed via ALL > Configuration > Message Templates.

Context

Message Templates Contexts are simply labels to group Message Templates to the context in which they are intended to be used, reducing clutter in the configuration. The following Contexts are defined:

• Enrollment Handoff: Used when a Notification is sent as part of an Enrollment Flow Step handoff
• Plugin: A generic Context intended for Message Templates used by Plugins
• Verification: Used for Email Address verifications

Message Formats

Message Templates support Plain Text and HTML message bodies (either or both may be used).

CC and BCC Addresses

Message Templates may specify a comma separated list of email addresses to cc and/or bcc when the corresponding email is sent. These addresses are not further processed in any way, but they are ignored when an override delivery address is set in the SMTP Server configuration. See Overriding Delivery For Testing for more information.

Reply-To Address

Message Templates may specify a Reply-To address that overrides the default Reply-To address set in the SMTP Server configuration.

Message Template Substitutions

Message Templates support Substitutions, which are tokens that can be replaced with content appropriate to the message context. Substitutions are available for the relevant message subject as well as the message body (both plain text and HTML).

A substitution is made by taking the relevant string, such as CO_NAME, and prefixing it with an @ and embedding it within parentheses. This will generate a token like (@CO_NAME).

Which Substitutions are available depends on the Message Template Context, as listed in the chart below. Plugins may support their own set of Substitutions, review the appropriate Plugin's documentation for more details.

See Also

• Registry PE Notifications