EmailPluginOptions

EmailPluginOptions

Configuration for the EmailPlugin.

Signature

interface EmailPluginOptions {
  templatePath: string;
  transport: EmailTransportOptions;
  handlers: EmailEventHandler[];
  globalTemplateVars?: { [key: string]: any; };
}

Members

templatePath

property
type:
string

The path to the location of the email templates. In a default Vendure installation, the templates are installed to <project root>/vendure/email/templates.

transport

property

Configures how the emails are sent.

handlers

property

An array of EmailEventHandlers which define which Vendure events will trigger emails, and how those emails are generated.

globalTemplateVars

property
type:
{ [key: string]: any; }

An object containing variables which are made available to all templates. For example, the storefront URL could be defined here and then used in the “email address verification” email.