Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

SES

SES: any

is an option that expects an instantiated aws.SES object

Optional alternatives

alternatives: Attachment[]

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

Optional attachments

attachments: Attachment[]

An array of attachment objects

Optional bcc

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

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>

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

Optional component

component: undefined | string

Optional date

date: Date | string

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

Optional disableFileAccess

disableFileAccess: undefined | false | true

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

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

Optional dkim

dkim: Options

is an object with DKIM options

Optional encoding

encoding: undefined | string

optional transfer encoding for the textual parts

Optional envelope

envelope: Envelope | Envelope

optional SMTP envelope, if auto generated envelope is not suitable

Optional from

from: string | Address

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

An object or array of additional header fields

Optional html

html: string | Buffer | Readable | AttachmentLike

The HTML version of the message

Optional icalEvent

icalEvent: string | Buffer | Readable | IcalAttachment

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

The message-id this message is replying

Optional list

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

Optional maxConnections

maxConnections: undefined | number

How many messages per second is allowed to be delivered to SES

Optional messageId

messageId: undefined | string

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

Optional raw

raw: string | Buffer | Readable | AttachmentLike

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[]

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

Optional replyTo

replyTo: string | Address

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

Optional sender

sender: string | Address

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

Optional sendingRate

sendingRate: undefined | number

How many parallel connections to allow towards SES

Optional ses

ses: undefined | object

All keys are added to the SendRawEmail method options

Optional subject

subject: undefined | string

The subject of the e-mail

Optional text

text: string | Buffer | Readable | AttachmentLike

The plaintext version of the message

Optional textEncoding

textEncoding: TextEncoding

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>

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

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

Methods

Optional normalizeHeaderKey

  • normalizeHeaderKey(key: string): string
  • method to normalize header keys for custom caseing

    Parameters

    • key: string

    Returns string

Generated using TypeDoc