Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional cid

cid: undefined | string

optional content id for using inline images in HTML message source. Using cid sets the default contentDisposition to 'inline' and moves the attachment into a multipart/related mime node, so use it only if you actually want to use this attachment as an embedded image

Optional content

content: string | Buffer | Readable

String, Buffer or a Stream contents for the attachmentent

Optional contentDisposition

contentDisposition: "attachment" | "inline"

optional content disposition type for the attachment, defaults to ‘attachment’

Optional contentTransferEncoding

contentTransferEncoding: "7bit" | "base64" | "quoted-printable" | false

optional transfer encoding for the attachment, if not set it will be derived from the contentType property. Example values: quoted-printable, base64. If it is unset then base64 encoding is used for the attachment. If it is set to false then previous default applies (base64 for most, 7bit for text).

Optional contentType

contentType: undefined | string

optional content type for the attachment, if not set will be derived from the filename property

Optional encoding

encoding: undefined | string

If set and content is string, then encodes the content to a Buffer using the specified encoding. Example values: base64, hex, binary etc. Useful if you want to use binary attachments in a JSON formatted e-mail object

Optional filename

filename: string | false

filename to be reported as the name of the attached file, use of unicode is allowed. If you do not want to use a filename, set this value as false, otherwise a filename is generated automatically

Optional headers

headers: Headers

is an object of additional headers

Optional path

path: string | Url

path to a file or an URL (data uris are allowed as well) if you want to stream the file instead of including it (better for larger attachments)

Optional raw

raw: string | Buffer | Readable | AttachmentLike

an optional value that overrides entire node content in the mime message. If used then all other options set for this node are ignored.

Generated using TypeDoc