Class Attachments

Nylas Attachments API

The Nylas Attachments API allows you to retrieve metadata and download attachments.

You can use the attachments schema in a Send v3 request to send attachments regardless of the email provider. To include attachments in a Send v3 request, all attachments must be base64 encoded and the encoded data must be placed in the content field in the request body.

If you are using draft support, the draft including the attachment is stored on the provider. If you are not using draft support, Nylas stores the attachment.

Attachment size is currently limited by each provider. 3MB for Gmail messages 10MB for Microsoft messages

You can also send attachments inline in an email message, for example for images that should be displayed in the email body content.

Hierarchy

  • Resource
    • Attachments

Constructors

constructor

Properties

apiClient

Methods

_create _destroy _find _getRaw _list _update _updatePatch download find

Constructors

constructor

Properties

Protected apiClient

apiClient: default

Methods

Protected _create

Protected _destroy

  • _destroy<T>(__namedParameters): Promise<T>

  • Type Parameters

    • T

    Parameters

    • __namedParameters: DestroyParams

    Returns Promise<T>

Protected _find

Protected _getRaw

  • _getRaw(__namedParameters): Promise<Buffer>

  • Parameters

    • __namedParameters: FindParams<void>

    Returns Promise<Buffer>

Protected _list

Protected _update

Protected _updatePatch

download

  • Returns an attachment by ID.

    Parameters

    • __namedParameters: DownloadAttachmentParams & Overrides

    Returns Promise<Buffer>

    The Attachment file in binary format

find

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc