Class Messages

Nylas Messages API

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

Hierarchy

Resource
- Messages

Index

Constructors

constructor

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

Properties

`Protected` apiClient

apiClient: default

smartCompose

smartCompose: SmartCompose

`Static` MAXIMUM_JSON_ATTACHMENT_SIZE

MAXIMUM_JSON_ATTACHMENT_SIZE: number = ...

Methods

`Protected` _create

_create<T>(params): 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): 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): 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): Promise<Buffer>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<Buffer>
Inherited from Resource._getRaw
- Defined in src/resources/resource.ts:199

`Protected` _getStream

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

`Protected` _list

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

`Protected` _update

_update<T>(params): 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): 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): 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:296

destroy

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

find

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

findScheduledMessage

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

list

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

listScheduledMessages

listScheduledMessages(__namedParameters): 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:246

send

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

stopScheduledMessage

stopScheduledMessage(__namedParameters): 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:279

update

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

`Static` _buildFormRequest

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

Generated using TypeDoc