### Hierarchy

- MailOptions
- TransportOptions
- Options
  - Options

## Index

### Properties

- alternatives
- attachments
- auth
- authMethod
- bcc
- cc
- component
- connection
- connectionTimeout
- date
- debug
- disableFileAccess
- disableUrlAccess
- dkim
- dsn
- encoding
- envelope
- from
- greetingTimeout
- headers
- host
- html
- icalEvent
- ignoreTLS
- inReplyTo
- list
- localAddress
- logger
- messageId
- name
- opportunisticTLS
- port
- raw
- references
- replyTo
- requireTLS
- secure
- sender
- service
- socket
- socketTimeout
- subject
- text
- textEncoding
- tls
- to
- transactionLog
- url
- watchHtml

### Methods

- getSocket
- normalizeHeaderKey

## Properties

### Optional alternatives

alternatives: Attachment[]

Inherited from Options.alternatives

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:119

An array of alternative text contents (in addition to text and html parts)

### Optional attachments

attachments: Attachment[]

Inherited from Options.attachments

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:117

An array of attachment objects

### Optional auth

auth: AuthenticationType

Inherited from MailOptions.auth

Overrides Options.auth

- Defined in node_modules/@types/nodemailer/lib/smtp-transport.d.ts:33

### Optional authMethod

authMethod: undefined | string

Inherited from Options.authMethod

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:133

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

### Optional bcc

bcc: string | Address | Array<string | Address>

Inherited from Options.bcc

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:95

Comma separated list or an array of recipients e-mail addresses that will appear on the Bcc: field

### Optional cc

cc: string | Address | Array<string | Address>

Inherited from Options.cc

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:93

Comma separated list or an array of recipients e-mail addresses that will appear on the Cc: field

### Optional component

component: undefined | string

Inherited from TransportOptions.component

- Defined in node_modules/@types/nodemailer/index.d.ts:41

### Optional connection

connection: net.Socket

Inherited from Options.connection

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:139

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

Inherited from Options.connectionTimeout

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:121

how many milliseconds to wait for the connection to establish

### Optional date

date: Date | string

Inherited from Options.date

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:125

optional Date value, current UTC string will be used if not set

### Optional debug

debug: undefined | false | true

Inherited from Options.debug

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:131

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

### Optional disableFileAccess

disableFileAccess: undefined | false | true

Inherited from Options.disableFileAccess

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:135

if set to true then fails with an error when a node tries to load content from a file

### Optional disableUrlAccess

disableUrlAccess: undefined | false | true

Inherited from Options.disableUrlAccess

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:133

if set to true then fails with an error when a node tries to load content from URL

### Optional dkim

dkim: Options

Inherited from Options.dkim

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:137

is an object with DKIM options

### Optional dsn

dsn: DSNOptions

Inherited from MailOptions.dsn

- Defined in node_modules/@types/nodemailer/lib/smtp-transport.d.ts:34

### Optional encoding

encoding: undefined | string

Inherited from Options.encoding

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:127

optional transfer encoding for the textual parts

### Optional envelope

envelope: Envelope | Envelope

Inherited from Options.envelope

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:121

optional SMTP envelope, if auto generated envelope is not suitable

### Optional from

from: string | Address

Inherited from Options.from

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:87

The e-mail address of the sender. All e-mail addresses can be plain 'sender@server.com' or formatted 'Sender Name sender@server.com'

### Optional greetingTimeout

greetingTimeout: ms

Inherited from Options.greetingTimeout

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:123

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

### Optional headers

headers: Headers

Inherited from Options.headers

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:113

An object or array of additional header fields

### Optional host

host: undefined | string

Inherited from Options.host

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:103

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

### Optional html

html: string | Buffer | Readable | AttachmentLike

Inherited from Options.html

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:107

The HTML version of the message

### Optional icalEvent

icalEvent: string | Buffer | Readable | IcalAttachment

Inherited from Options.icalEvent

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:111

iCalendar event, same usage as with text and html. Event method attribute defaults to ‘PUBLISH’ or define it yourself: {method: 'REQUEST', content: iCalString}. This value is added as an additional alternative to html or text. Only utf-8 content is allowed

### Optional ignoreTLS

ignoreTLS: undefined | false | true

Inherited from Options.ignoreTLS

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:111

turns off STARTTLS support if true

### Optional inReplyTo

inReplyTo: string | Address

Inherited from Options.inReplyTo

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:99

The message-id this message is replying

### Optional list

list: ListHeaders

Inherited from Options.list

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:115

An object where key names are converted into list headers. List key help becomes List-Help header etc.

### Optional localAddress

localAddress: undefined | string

Inherited from Options.localAddress

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:119

the local interface to bind to for network connections

### Optional logger

logger: Logger | boolean

Inherited from Options.logger

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:127

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 messageId

messageId: undefined | string

Inherited from Options.messageId

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:123

optional Message-Id value, random value will be generated if not set

### Optional name

name: undefined | string

Inherited from Options.name

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:117

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

### Optional opportunisticTLS

opportunisticTLS: undefined | false | true

Inherited from Options.opportunisticTLS

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:115

tries to use STARTTLS and continues normally if it fails

### Optional port

port: undefined | number

Inherited from Options.port

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:105

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

### Optional raw

raw: string | Buffer | Readable | AttachmentLike

Inherited from Options.raw

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:129

if set then overwrites entire message output with this value. The value is not parsed, so you should still set address headers or the envelope value for the message to work

### Optional references

references: string | string[]

Inherited from Options.references

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:101

Message-id list (an array or space separated string)

### Optional replyTo

replyTo: string | Address

Inherited from Options.replyTo

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:97

An e-mail address that will appear on the Reply-To: field

### Optional requireTLS

requireTLS: undefined | false | true

Inherited from Options.requireTLS

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:113

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

### Optional secure

secure: undefined | false | true

Inherited from Options.secure

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:109

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

### Optional sender

sender: string | Address

Inherited from Options.sender

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:89

An e-mail address that will appear on the Sender: field

### Optional service

service: undefined | string

- Defined in node_modules/@types/nodemailer/lib/smtp-transport.d.ts:38

### Optional socket

socket: net.Socket

Inherited from Options.socket

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:137

initialized socket to use instead of creating a new one

### Optional socketTimeout

socketTimeout: ms

Inherited from Options.socketTimeout

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:125

how many milliseconds of inactivity to allow

### Optional subject

subject: undefined | string

Inherited from Options.subject

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:103

The subject of the e-mail

### Optional text

text: string | Buffer | Readable | AttachmentLike

Inherited from Options.text

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:105

The plaintext version of the message

### Optional textEncoding

textEncoding: TextEncoding

Inherited from Options.textEncoding

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:131

set explicitly which encoding to use for text parts (quoted-printable or base64). If not set then encoding is detected from text content (mostly ascii means quoted-printable, otherwise base64)

### Optional tls

tls: tls.ConnectionOptions

Inherited from Options.tls

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:135

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

### Optional to

to: string | Address | Array<string | Address>

Inherited from Options.to

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:91

Comma separated list or an array of recipients e-mail addresses that will appear on the To: field

### Optional transactionLog

transactionLog: undefined | false | true

Inherited from Options.transactionLog

- Defined in node_modules/@types/nodemailer/lib/smtp-connection.d.ts:129

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

### Optional url

url: undefined | string

- Defined in node_modules/@types/nodemailer/lib/smtp-transport.d.ts:40

### Optional watchHtml

watchHtml: string | Buffer | Readable | AttachmentLike

Inherited from Options.watchHtml

- Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:109

Apple Watch specific HTML version of the message, same usage as with text and html

## Methods

### Optional getSocket

- getSocket(options: Options, callback: function): void

- - Defined in node_modules/@types/nodemailer/lib/smtp-transport.d.ts:39

  #### Parameters

  - ##### options: Options

  - ##### callback: function

    - - (err: Error | null, socketOptions: any): void

      - #### Parameters

        - ##### err: Error | null

        - ##### socketOptions: any

        #### Returns void

### Optional normalizeHeaderKey

- normalizeHeaderKey(key: string): string

- Inherited from Options.normalizeHeaderKey

  - Defined in node_modules/@types/nodemailer/lib/mailer/index.d.ts:139

  method to normalize header keys for custom caseing

  #### Parameters

  - ##### key: string

  #### Returns string

Generated using TypeDoc