SMTPTransportOptions

SMTPTransportOptions

A subset of the SMTP transport options of Nodemailer

Signature

interface SMTPTransportOptions {
  type: 'smtp';
  host: string;
  port: number;
  auth: SMTPCredentials;
  secure?: boolean;
  ignoreTLS?: boolean;
  requireTLS?: boolean;
  name?: string;
  localAddress?: string;
  authMethod?: string;
}

Members

type

property
type:
'smtp'

host

property
type:
string

the hostname or IP address to connect to (defaults to ‘localhost’)

port

property
type:
number

The port to connect to (defaults to 25 or 465)

auth

property
type:
SMTPCredentials

Defines authentication data

secure

property
type:
boolean

Defines if the connection should use SSL (if true) or not (if false)

ignoreTLS

property
type:
boolean

Turns off STARTTLS support if true

requireTLS

property
type:
boolean

Forces the client to use STARTTLS. Returns an error if upgrading the connection is not possible or fails.

name

property
type:
string

Optional hostname of the client, used for identifying to the server

localAddress

property
type:
string

The local interface to bind to for network connections

authMethod

property
type:
string

Defines preferred authentication method, e.g. ‘PLAIN’