A union of all the possible transport options for sending emails.
The SMTP transport options of Nodemailer
'smtp'booleanfalseIf true, uses the configured VendureLogger to log messages from Nodemailer as it interacts with the SMTP server.
booleanfalseSet 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().
SMTPPool.Options['maxConnections']5The maximum number of simultaneous connections to make against the SMTP server.
Only applies when pool is true.
SMTPPool.Options['maxMessages']100Limits 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.
SMTPPool.Options['rateDelta']1000Defines the time measuring period in milliseconds for rate limiting. Only applies when pool is true.
SMTPPool.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.
The SES transport options of Nodemailer
See Nodemailers's SES docs for more details
Example
Uses the local Sendmail program to send the email.
Outputs the email as an HTML file for development purposes.
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.
Forwards the raw GeneratedEmailContext object to a provided callback, for use in testing.
'testing'(details: EmailDetails) => voidCallback to be invoked when an email would be sent.