Transport Options

EmailTransportOptions

A union of all the possible transport options for sending emails.

Signature

type EmailTransportOptions = | SMTPTransportOptions    | SendmailTransportOptions    | FileTransportOptions    | NoopTransportOptions    | SESTransportOptions    | TestingTransportOptions

SMTPTransportOptions

@vendure/email-plugin Source

The SMTP transport options of Nodemailer

Signature

interface SMTPTransportOptions extends SMTPTransport.Options {    type: 'smtp';    logging?: boolean;    pool?: boolean;    maxConnections?: SMTPPool.Options['maxConnections'];    maxMessages?: SMTPPool.Options['maxMessages'];    rateDelta?: SMTPPool.Options['rateDelta'];    rateLimit?: SMTPPool.Options['rateLimit'];}

Extends: SMTPTransport.Options

type

property'smtp'

logging

propertyboolean

Default:false

If true, uses the configured VendureLogger to log messages from Nodemailer as it interacts with the SMTP server.

pool

propertyboolean

Default:false

Set to true to use a pooled connection (defaults to false) instead of creating a new connection for every email. Nodemailer pooled-SMTP option, forwarded directly to nodemailer.createTransport().

maxConnections

propertySMTPPool.Options['maxConnections']

Default:5

The maximum number of simultaneous connections to make against the SMTP server. Only applies when pool is true.

maxMessages

propertySMTPPool.Options['maxMessages']

Default:100

Limits the number of messages sent over a single connection. After maxMessages is reached the connection is dropped and a new one is created. Only applies when pool is true.

rateDelta

propertySMTPPool.Options['rateDelta']

Default:1000

Defines the time measuring period in milliseconds for rate limiting. Only applies when pool is true.

rateLimit

propertySMTPPool.Options['rateLimit']

Limits the number of messages sent in the rateDelta window. Once reached, sending is paused until the end of the period. Only applies when pool is true.

SESTransportOptions

@vendure/email-plugin Source

The SES transport options of Nodemailer

See Nodemailers's SES docs for more details

Example

import { SES, SendRawEmailCommand } from '@aws-sdk/client-ses' const ses = new SES({    apiVersion: '2010-12-01',    region: 'eu-central-1',    credentials: {        accessKeyId: process.env.SES_ACCESS_KEY || '',        secretAccessKey: process.env.SES_SECRET_KEY || '',    }, }) const config: VendureConfig = {  // Add an instance of the plugin to the plugins array  plugins: [    EmailPlugin.init({      handler: defaultEmailHandlers,      templateLoader: new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),      transport: {        type: 'ses',        SES: { ses, aws: { SendRawEmailCommand } },        sendingRate: 10, // optional messages per second sending rate      },    }),  ],};

Signature

interface SESTransportOptions extends SESTransport.Options {    type: 'ses';}

Extends: SESTransport.Options

type

property'ses'

SendmailTransportOptions

@vendure/email-plugin Source

Uses the local Sendmail program to send the email.

Signature

interface SendmailTransportOptions {    type: 'sendmail';    path?: string;    newline?: string;}

type

property'sendmail'

path

propertystring

newline

propertystring

FileTransportOptions

@vendure/email-plugin Source

Outputs the email as an HTML file for development purposes.

Signature

interface FileTransportOptions {    type: 'file';    outputPath: string;    raw?: boolean;}

type

property'file'

outputPath

propertystring

raw

propertyboolean

NoopTransportOptions

@vendure/email-plugin Source

Does nothing with the generated email. Intended for use in testing where we don't care about the email transport, or when using a custom EmailSender which does not require transport options.

Signature

interface NoopTransportOptions {    type: 'none';}

type

property'none'

TestingTransportOptions

@vendure/email-plugin Source

Forwards the raw GeneratedEmailContext object to a provided callback, for use in testing.

Signature

interface TestingTransportOptions {    type: 'testing';    onSend: (details: EmailDetails) => void;}

type

property'testing'

onSend

property(details: EmailDetails) => void

Callback to be invoked when an email would be sent.

Was this chapter helpful?

Report Issue

Edited Jun 24, 2026·Edit this page