EmailTemplateConfig

EmailTemplateConfig

Package: @vendure/email-plugin File: types.ts

Configures the EmailEventHandler to handle a particular channel & languageCode combination.

Signature

interface EmailTemplateConfig {
  channelCode: string | 'default';
  languageCode: LanguageCode | 'default';
  templateFile: string;
  subject: string;
}

Members

channelCode

property

type:

string | 'default'

Specifies the channel to which this configuration will apply. If set to 'default', it will be applied to all channels.

languageCode

property

type:

LanguageCode | 'default'

Specifies the languageCode to which this configuration will apply. If set to 'default', it will be applied to all languages.

templateFile

property

type:

string

Defines the file name of the Handlebars template file to be used to when generating this email.

subject

property

type:

string

A string defining the email subject line. Handlebars variables defined in the templateVars object may be used inside the subject.