Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional auth

defines authentication data

Optional authMethod

authMethod: undefined | string

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

Optional connection

connection: net.Socket

connected socket to use instead of creating and connecting a new one. If secure option is true, then socket is upgraded from plaintext to ciphertext

Optional connectionTimeout

connectionTimeout: ms

how many milliseconds to wait for the connection to establish

Optional debug

debug: undefined | false | true

if set to true, then logs SMTP traffic and message content, otherwise logs only transaction events

Optional greetingTimeout

greetingTimeout: ms

how many milliseconds to wait for the greeting after connection is established

Optional host

host: undefined | string

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

Optional ignoreTLS

ignoreTLS: undefined | false | true

turns off STARTTLS support if true

Optional localAddress

localAddress: undefined | string

the local interface to bind to for network connections

Optional logger

logger: Logger | boolean

optional bunyan compatible logger instance. If set to true then logs to console. If value is not set or is false then nothing is logged

Optional name

name: undefined | string

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

Optional opportunisticTLS

opportunisticTLS: undefined | false | true

tries to use STARTTLS and continues normally if it fails

Optional port

port: undefined | number

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

Optional requireTLS

requireTLS: undefined | false | true

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

Optional secure

secure: undefined | false | true

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

Optional socket

socket: net.Socket

initialized socket to use instead of creating a new one

Optional socketTimeout

socketTimeout: ms

how many milliseconds of inactivity to allow

Optional tls

tls: tls.ConnectionOptions

defines additional options to be passed to the socket constructor, e.g. {rejectUnauthorized: true}

Optional transactionLog

transactionLog: undefined | false | true

if set to true, then logs SMTP traffic without message content

Generated using TypeDoc