Class Messages

Nylas Messages API

The Nylas Messages API allows you to list, find, update, delete, schedule, and send messages on user accounts.

Constructors

constructor

new Messages(apiClient: APIClient): Messages
Parameters
- apiClient: APIClient
Returns Messages
Overrides Resource.constructor
- Defined in src/resources/messages.ts:133

Properties

`Protected`apiClient

apiClient: APIClient

smartCompose

smartCompose: SmartCompose

`Static`MAXIMUM_JSON_ATTACHMENT_SIZE

MAXIMUM_JSON_ATTACHMENT_SIZE: number = ...

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>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream>
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

cleanMessages

cleanMessages(
__namedParameters: CleanMessagesParams & Overrides,
): Promise<NylasListResponse<CleanMessagesResponse>>
Remove extra information from a list of messages
Parameters
- __namedParameters: CleanMessagesParams & Overrides
Returns Promise<NylasListResponse<CleanMessagesResponse>>
The list of cleaned messages
- Defined in src/resources/messages.ts:329

destroy

destroy(
__namedParameters: DestroyMessageParams & Overrides,
): Promise<NylasBaseResponse>
Delete a Message
Parameters
- __namedParameters: DestroyMessageParams & Overrides
Returns Promise<NylasBaseResponse>
The deleted message
- Defined in src/resources/messages.ts:212

find

find(
__namedParameters: FindMessageParams & Overrides,
): Promise<NylasResponse<Message>>
Return a Message
Parameters
- __namedParameters: FindMessageParams & Overrides
Returns Promise<NylasResponse<Message>>
The message
- Defined in src/resources/messages.ts:172

findScheduledMessage

findScheduledMessage(
__namedParameters: FindScheduledMessageParams & Overrides,
): Promise<NylasResponse<ScheduledMessage>>
Retrieve a scheduled message
Parameters
- __namedParameters: FindScheduledMessageParams & Overrides
Returns Promise<NylasResponse<ScheduledMessage>>
The scheduled message
- Defined in src/resources/messages.ts:289

list

list(
__namedParameters: ListMessagesParams & Overrides,
): AsyncListResponse<NylasListResponse<Message>>
Return all Messages
Parameters
- __namedParameters: ListMessagesParams & Overrides
Returns AsyncListResponse<NylasListResponse<Message>>
A list of messages
- Defined in src/resources/messages.ts:142

listScheduledMessages

listScheduledMessages(
__namedParameters: ListScheduledMessagesParams & Overrides,
): Promise<NylasResponse<ScheduledMessagesList>>
Retrieve your scheduled messages
Parameters
- __namedParameters: ListScheduledMessagesParams & Overrides
Returns Promise<NylasResponse<ScheduledMessagesList>>
A list of scheduled messages
- Defined in src/resources/messages.ts:271

send

send(
__namedParameters: SendMessageParams & Overrides,
): Promise<NylasResponse<Message>>
Send an email
Parameters
- __namedParameters: SendMessageParams & Overrides
Returns Promise<NylasResponse<Message>>
The sent message
- Defined in src/resources/messages.ts:230

stopScheduledMessage

stopScheduledMessage(
__namedParameters: FindScheduledMessageParams & Overrides,
): Promise<NylasResponse<StopScheduledMessageResponse>>
Stop a scheduled message
Parameters
- __namedParameters: FindScheduledMessageParams & Overrides
Returns Promise<NylasResponse<StopScheduledMessageResponse>>
The confirmation of the stopped scheduled message
- Defined in src/resources/messages.ts:309

update

update(
__namedParameters: UpdateMessageParams & Overrides,
): Promise<NylasResponse<Message>>
Update a Message
Parameters
- __namedParameters: UpdateMessageParams & Overrides
Returns Promise<NylasResponse<Message>>
The updated message
- Defined in src/resources/messages.ts:192

`Static`_buildFormRequest

_buildFormRequest(
    requestBody:
        | CreateDraftRequest
        | SendMessageRequest
        | UpdateDraftRequest,
): FormData
Parameters
- requestBody: CreateDraftRequest | SendMessageRequest | UpdateDraftRequest
Returns FormData
- Defined in src/resources/messages.ts:346