### Hierarchy

- Options
- TransportOptions
  - Options

## Index

### Properties

- alternatives
- args
- attachments
- bcc
- cc
- component
- date
- disableFileAccess
- disableUrlAccess
- dkim
- encoding
- envelope
- from
- headers
- html
- icalEvent
- inReplyTo
- list
- messageId
- newline
- path
- raw
- references
- replyTo
- sender
- sendmail
- subject
- text
- textEncoding
- to
- watchHtml

### Methods

- 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 args

args: string[]

- Defined in node_modules/@types/nodemailer/lib/sendmail-transport/index.d.ts:21

an optional array of command line options to pass to the sendmail command (ie. ["-f", "foo@blurdybloop.com"]). This overrides all default arguments except for ’-i’ and recipient list so you need to make sure you have all required arguments set (ie. the ‘-f’ flag).

### 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 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 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 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 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 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 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 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 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 newline

newline: undefined | string

- Defined in node_modules/@types/nodemailer/lib/sendmail-transport/index.d.ts:19

either ‘windows’ or ‘unix’ (default). Forces all newlines in the output to either use Windows syntax or Unix syntax

### Optional path

path: undefined | string

- Defined in node_modules/@types/nodemailer/lib/sendmail-transport/index.d.ts:17

path to the sendmail command (defaults to ‘sendmail’)

### 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 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

### sendmail

sendmail: true

- Defined in node_modules/@types/nodemailer/lib/sendmail-transport/index.d.ts:15

### 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 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 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 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