EmailPluginDevModeOptions

EmailPluginDevModeOptions

Configuration for running the EmailPlugin in development mode.

Signature

interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'> {
  devMode: true;
  outputPath: string;
  mailboxPort?: number;
}

Members

devMode

property
type:
true

outputPath

property
type:
string

The path to which html email files will be saved rather than being sent.

mailboxPort

property
type:
number

If set, a “mailbox” server will be started which will serve the contents of the outputPath similar to a web-based email client, available at the route /mailbox, e.g. http://localhost:3000/mailbox.