Class Folders

Nylas Folder API

Email providers use folders to store and organize email messages. Examples of common system folders include Inbox, Sent, Drafts, etc.

If your team is migrating from Nylas APIv2, there were previously two separate endpoints for interacting with Folders (Microsoft) and Labels (Google). In Nylas API v3, these endpoints are consolidated under Folders.

To simplify the developer experience, Nylas uses the same folders commands to manage both folders and labels, using the folder_id key to refer to the folder's ID on the provider. The API also exposes provider-specific fields such as background_color (Google only).

Depending on the provider (Google, some IMAP providers, etc.), a message can be contained in more than one folder.

Hierarchy

  • Resource
    • Folders

Constructors

constructor

Properties

apiClient

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch create destroy find list update

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 _getStream

  • _getStream(__namedParameters): Promise<ReadableStream>

  • Parameters

    • __namedParameters: FindParams<void>

    Returns Promise<ReadableStream>

Protected _list

Protected _update

Protected _updatePatch

create

destroy

find

list

update

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc