EmailContext

EmailContext

Documentation generated from email-context.ts on Feb 19 2019 at 16:20

The EmailContext contains all the neccesary data required to generate an email (subject, body).

Signature

class EmailContext<T extends string = any, E extends VendureEvent = any> {
  public readonly type: T;
  public readonly recipient: string;
  public readonly event: E;
  public readonly languageCode: LanguageCode;
  public readonly channelCode: string;
  constructor(options: {
        type: T;
        languageCode: LanguageCode;
        channelCode: string;
        recipient: string;
        event: E;
    })
}

Members

type

property
type:
T

recipient

property
type:
string

event

property
type:
E

The VendureEvent which triggered this email

languageCode

property
type:
LanguageCode

channelCode

property
type:
string

constructor

method
type:
(options: { type: T; languageCode: LanguageCode; channelCode: string; recipient: string; event: E; }) => EmailContext
alpha