Email Plugin Types

EventWithContext

A VendureEvent which also includes a ctx property containing the current RequestContext, which is used to determine the channel and language to use when generating the email.

Signature

type EventWithContext = VendureEvent & { ctx: RequestContext }

EventWithAsyncData

A VendureEvent with a RequestContext and a data property which contains the value resolved from the EmailEventHandler.loadData() callback.

Signature

type EventWithAsyncData<Event extends EventWithContext, R> = Event & { data: R }

EmailDetails

The final, generated email details to be sent.

Signature

interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialized'> {
  from: string;
  recipient: string;
  subject: string;
  body: string;
  attachments: Array<Type extends 'serialized' ? SerializedAttachment : Attachment>;
  cc?: string;
  bcc?: string;
  replyTo?: string;
}

Members

from

recipient

subject

body

attachments

cc

bcc

replyTo

LoadDataFn

A function used to load async data for use by an EmailEventHandler.

Signature

type LoadDataFn<Event extends EventWithContext, R> = (context: {
    event: Event;
    injector: Injector;
}) => Promise<R>

EmailAttachment

An object defining a file attachment for an email. Based on the object described here in the Nodemailer docs, but only uses the path property to define a filesystem path or a URL pointing to the attachment file.

Signature

type EmailAttachment = Omit<Attachment, 'raw'> & { path?: string }

EmailTemplateConfig

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

languageCode

templateFile

subject

SetTemplateVarsFn

A function used to define template variables available to email templates. See EmailEventHandler.setTemplateVars().

Signature

type SetTemplateVarsFn<Event> = (
    event: Event,
    globals: { [key: string]: any },
) => { [key: string]: any }

SetAttachmentsFn

A function used to define attachments to be sent with the email. See https://nodemailer.com/message/attachments/ for more information about how attachments work in Nodemailer.

Signature

type SetAttachmentsFn<Event> = (event: Event) => EmailAttachment[] | Promise<EmailAttachment[]>

OptionalAddressFields

Optional address-related fields for sending the email.

Signature

interface OptionalAddressFields {
  cc?: string;
  bcc?: string;
  replyTo?: string;
}

Members

cc

bcc

replyTo

SetOptionalAddressFieldsFn

A function used to set the OptionalAddressFields.

Signature

type SetOptionalAddressFieldsFn<Event> = (
    event: Event,
) => OptionalAddressFields | Promise<OptionalAddressFields>