stringThe path to the location of the email templates. In a default Vendure installation,
the templates are installed to <project root>/vendure/email/templates.
An optional TemplateLoader which can be used to load templates from a custom location or async service.
The default uses the FileBasedTemplateLoader which loads templates from <project root>/vendure/email/templates
| EmailTransportOptions | (( injector?: Injector, ctx?: RequestContext, ) => EmailTransportOptions | Promise<EmailTransportOptions>)Configures how the emails are sent.
Array<EmailEventHandler<string, any>>An array of EmailEventHandlers which define which Vendure events will trigger emails, and how those emails are generated.
{ [key: string]: any } | GlobalTemplateVarsFnAn 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. Use the GlobalTemplateVarsFn if you need to retrieve variables from Vendure or plugin services.
EmailSender<a href='/reference/core-plugins/email-plugin/email-sender#nodemaileremailsender'>NodemailerEmailSender</a>An optional allowed EmailSender, used to allow custom implementations of the send functionality while still utilizing the existing emailPlugin functionality.
EmailGenerator<a href='/reference/core-plugins/email-plugin/email-generator#handlebarsmjmlgenerator'>HandlebarsMjmlGenerator</a>An optional allowed EmailGenerator, used to allow custom email generation functionality to better match with custom email sending functionality.
Allows you to dynamically load the "globalTemplateVars" key async and access Vendure services to create the object. This is not a requirement. You can also specify a simple static object if your projects doesn't need to access async or dynamic values.
Example
Configuration for running the EmailPlugin in development mode.
Omit<EmailPluginOptions, 'transport'>Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the team