TemplateConfig

TemplateConfig

Documentation generated from email-options.ts on Mar 14 2019 at 20:14

This object defines the template location and context data used for interpolation of an email for a particular language of a particular channel.

Signature

type TemplateConfig<C = any, R = any> = {
  templateContext: (emailContext: C) => R;
  subject: string;
  templatePath: string;
}

Members

templateContext

property
type:
(emailContext: C) => R

A function which uses the EmailContext to provide a context object for the template engine. That is, the templates will have access to the object returned by this function.

subject

property
type:
string

The subject line for the email.

templatePath

property
type:
string

The path to the template file for the body of the email.

alpha