EmailOptions

EmailOptions

Documentation generated from vendure-config.ts on Feb 19 2019 at 16:20

Defines how transactional emails (account verification, order confirmation etc) are generated and sent.

It is usually not recommended to configure these yourself. You should use the DefaultEmailPlugin.

Signature

interface EmailOptions<EmailType extends string> {
  emailTemplatePath: string;
  emailTypes?: EmailTypes<EmailType>;
  generator?: EmailGenerator;
  transport: EmailTransportOptions;
}

Members

emailTemplatePath

property
type:
string
default:
__dirname

Path to the email template files.

emailTypes

property
type:
EmailTypes<EmailType>
default:
{}

Configuration for the creation and templating of each email type

generator

property
default:
NoopEmailGenerator

The EmailGenerator uses the EmailContext and template to generate the email body

transport

property
default:
NoopTransportOptions

Configuration for the transport (email sending) method

alpha