nylas
    Preparing search index...

    Nylas Attachments API

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

    Index

    Constructors

    Properties

    apiClient: APIClient

    Methods

    • Type Parameters

      • T

      Parameters

      • __namedParameters: DestroyParams

      Returns Promise<T>

    • Parameters

      • __namedParameters: FindParams<void>

      Returns Promise<Buffer<ArrayBufferLike>>

    • Parameters

      • __namedParameters: FindParams<void>

      Returns Promise<ReadableStream>

    • Download the attachment data

      This method returns a NodeJS.ReadableStream which can be used to stream the attachment data. This is particularly useful for handling large attachments efficiently, as it avoids loading the entire file into memory. The stream can be piped to a file stream or used in any other way that Node.js streams are typically used.

      Parameters

      • __namedParameters: DownloadAttachmentParams & Overrides

      Returns Promise<ReadableStream>

      The ReadableStream containing the file data.

    • Download the attachment as a byte array

      Parameters

      • __namedParameters: DownloadAttachmentParams & Overrides

      Returns Promise<Buffer<ArrayBufferLike>>

      The raw file data