Class Attachments

Nylas Attachments API

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

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch completeUploadSession createUploadSession download downloadBytes downloadNodeStream find

Constructors

constructor

new Attachments(apiClient: APIClient): Attachments
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Attachments
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:50

Properties

`Protected`apiClient

apiClient: APIClient

Methods

`Protected`_create

_create<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._create
- Defined in src/resources/resource.ts:170

`Protected`_destroy

_destroy<T>(__namedParameters: DestroyParams): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: DestroyParams
Returns Promise<T>
Inherited from Resource._destroy
- Defined in src/resources/resource.ts:184

`Protected`_find

_find<T>(__namedParameters: FindParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FindParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._find
- Defined in src/resources/resource.ts:144

`Protected`_getRaw

_getRaw(__namedParameters: FindParams<void>): Promise<Buffer<ArrayBufferLike>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<Buffer<ArrayBufferLike>>
Inherited from Resource._getRaw
- Defined in src/resources/resource.ts:199

`Protected`_getStream

_getStream(
__namedParameters: FindParams<void>,
): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
Inherited from Resource._getStream
- Defined in src/resources/resource.ts:212

`Protected`_list

_list<T extends List<T>>(listParams: ListParams<T>): AsyncListResponse<T>
Type Parameters
- T extends List<T>
Parameters
- listParams: ListParams<T>
Returns AsyncListResponse<T>
Inherited from Resource._list
- Defined in src/resources/resource.ts:124

`Protected`_update

_update<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._update
- Defined in src/resources/resource.ts:174

`Protected`_updatePatch

_updatePatch<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._updatePatch
- Defined in src/resources/resource.ts:178

completeUploadSession

completeUploadSession(
__namedParameters: CompleteAttachmentUploadSessionParams & Overrides,
): Promise<NylasResponse<AttachmentUploadSessionComplete>>
Complete an upload session after the file has been uploaded to the pre-signed URL.
Parameters
- __namedParameters: CompleteAttachmentUploadSessionParams & Overrides
Returns Promise<NylasResponse<AttachmentUploadSessionComplete>>
See
https://developer.nylas.com/docs/v3/email/send-large-attachments/
- Defined in src/resources/attachments.ts:193

createUploadSession

createUploadSession(
__namedParameters: CreateAttachmentUploadSessionParams & Overrides,
): Promise<NylasResponse<AttachmentUploadSession>>
Create a resumable upload session for a large attachment (up to 150 MB). Upload bytes to the returned url, then call Attachments.completeUploadSession.
Parameters
- __namedParameters: CreateAttachmentUploadSessionParams & Overrides
Returns Promise<NylasResponse<AttachmentUploadSession>>
Session details including attachmentId and pre-signed url

See
https://developer.nylas.com/docs/v3/email/send-large-attachments/
- Defined in src/resources/attachments.ts:172

download

download(
__namedParameters: DownloadAttachmentParams & Overrides,
): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
Download the attachment data

This method returns a Web 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. In Node.js, convert it with Readable.fromWeb() when a NodeJS.ReadableStream is required.
Parameters
- __namedParameters: DownloadAttachmentParams & Overrides
Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
The ReadableStream containing the file data.
- Defined in src/resources/attachments.ts:95

downloadBytes

downloadBytes(
__namedParameters: DownloadAttachmentParams & Overrides,
): Promise<Buffer<ArrayBufferLike>>
Download the attachment as a byte array
Parameters
- __namedParameters: DownloadAttachmentParams & Overrides
Returns Promise<Buffer<ArrayBufferLike>>
The raw file data
- Defined in src/resources/attachments.ts:149

downloadNodeStream

downloadNodeStream(
__namedParameters: DownloadAttachmentParams & Overrides,
): Promise<ReadableStream>
Download the attachment data as a Node.js readable stream.

This is a Node.js convenience wrapper around Attachments.download. Use Attachments.download directly in Fetch-native runtimes, such as Cloudflare Workers, where Web ReadableStreams are the standard stream primitive.
Parameters
- __namedParameters: DownloadAttachmentParams & Overrides
Returns Promise<ReadableStream>
The Node.js readable stream containing the file data.
- Defined in src/resources/attachments.ts:125

find

find(
__namedParameters: FindAttachmentParams & Overrides,
): Promise<NylasResponse<Attachment>>
Returns an attachment by ID.
Parameters
- __namedParameters: FindAttachmentParams & Overrides
Returns Promise<NylasResponse<Attachment>>
The Attachment metadata
- Defined in src/resources/attachments.ts:66

Class Attachments

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Attachments

Properties

ProtectedapiClient

Methods

Protected_create

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_destroy

Type Parameters

Parameters

Returns Promise<T>

Protected_find

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_getRaw

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Protected_getStream

Parameters

Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

Protected_list

Type Parameters

Parameters

Returns AsyncListResponse<T>

Protected_update

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_updatePatch

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

completeUploadSession

Parameters

Returns Promise<NylasResponse<AttachmentUploadSessionComplete>>

See

createUploadSession

Parameters

Returns Promise<NylasResponse<AttachmentUploadSession>>

See

download

Parameters

Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

downloadBytes

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

downloadNodeStream

Parameters

Returns Promise<ReadableStream>

find

Parameters

Returns Promise<NylasResponse<Attachment>>

Settings

On This Page

`Protected`apiClient

`Protected`_create

`Protected`_destroy

`Protected`_find

`Protected`_getRaw

`Protected`_getStream

`Protected`_list

`Protected`_update

`Protected`_updatePatch