Interface Attachment

Represents an attachment. This interface is compatible with Attachment of nodemailer.

interface Attachment {
    cid?: string;
    content?: string | Buffer<ArrayBufferLike> | Readable;
    contentDisposition?: "attachment" | "inline";
    contentTransferEncoding?: false | "7bit" | "base64" | "quoted-printable";
    contentType?: string;
    encoding?: string;
    filename?: string | false;
    headers?: Headers;
    path?: string | Url;
    raw?: string | Buffer<ArrayBufferLike> | Readable | AttachmentLike;
}

Hierarchy (View Summary)

Properties

cid? content? contentDisposition? contentTransferEncoding? contentType? encoding? filename? headers? path? raw?

Properties

Optionalcid

cid?: 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.

Optionalcontent

content?: string | Buffer<ArrayBufferLike> | Readable

Contents of the attachment stored in a string, buffer or stream.

OptionalcontentDisposition

contentDisposition?: "attachment" | "inline"

Content disposition type of the attachment. Defaults to attachment.

OptionalcontentTransferEncoding

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

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

OptionalcontentType

contentType?: string

Content type of the attachment. Will be derived from the filename property, if not set.

Optionalencoding

encoding?: string

Encoding used to encode the content to a buffer. Example values: base64, hex, binary etc. Useful if you want to use binary attachments in a JSON formatted e-mail object.

Optionalfilename

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 to false, otherwise a filename is generated automatically.

Optionalheaders

headers?: Headers

Additional headers to be sent with the attachment.

Optionalpath

path?: string | Url

File path or URL (data URIs are allowed as well) if you want to read a file instead of including it (better for larger attachments).

Optionalraw

raw?: string | Buffer<ArrayBufferLike> | Readable | AttachmentLike

A raw value that overrides entire node content in the MIME message. If used, all other options set for this node are ignored.

Copyright Ⓒ 2025 SAP SE or an SAP affiliate company. All rights reserved.

Settings

Member Visibility

On This Page

Properties