nextmail.chats
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The conversations held with the assistant in the app: list and search them, read one, rename it and delete it. Each person reaches only their own.
nextmail.chats.list()
List the assistant chats
list(options?: ChatListOptions): Promise<Page<ChatResource>>Resolves one page of the conversations held with the assistant in the app, newest first, as its Chats page lists them, each with its title, how many messages it holds and when it last changed.
Each person reaches only their own chats: an API key reaches the chats of the workspace owner, and an access token reaches the chats of the person who connected it. A key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
options.qstringSearches the titles.
options.sortChatSortnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.options.limitnumberPage size, from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorof the previous page. Leave it out for the first page.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
Page<ChatResource> with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.
Example
const page = await nextmail.chats.list({ q: 'invoices' }) for (const chat of page.items) console.log(chat.title, chat.messageCount)Notes
A cursor that names nothing in this list is 400
invalid_cursor.
Also available in
- API
GET /chats- Python
chats.list()- Ruby
chats.list- PHP
chats->list- Go
Chats.List- Java
chats().list- C#
Chats.ListAsync- CLI
openemail chats list
nextmail.chats.listAll()
Collect every chat into one array
listAll(options?: ChatListOptions): Promise<Array<ChatResource>>Walks every page of list and resolves with every chat, in the order sort names. One request per page, with the same filters on each.
Parameters
options.qstringSearches the titles.
options.sortChatSortnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.options.limitnumberPage size for each request, from 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk after this cursor instead of the first page.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Returns
Array<ChatResource> holding every chat.
Example
const chats = await nextmail.chats.listAll() console.log(chats.length)Notes
If any page fails the promise rejects and the rows already fetched are discarded.
Also available in
nextmail.chats.iterate()
Stream the chats one at a time
iterate(options?: ChatListOptions): AsyncGenerator<ChatResource, void, undefined>Returns an async generator that yields one chat at a time, in the order sort names, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.
Parameters
options.qstringSearches the titles.
options.sortChatSortnewest(the default) oroldestby the last change, ortitle. A cursor carries on in the order it was handed out in.options.limitnumberPage size for each request, from 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk after this cursor instead of the first page.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Returns
AsyncGenerator<ChatResource, void, undefined> yielding one chat per step.
Example
for await (const chat of nextmail.chats.iterate({ sort: 'title' })) console.log(chat.title)Notes
Each page is one request, so a long walk makes many.
Also available in
nextmail.chats.get()
Retrieve a chat
get(id: string, options?: RequestScope): Promise<ChatResource>Resolves one chat with the assistant by its id: its title, how many messages it holds and when it last changed.
Each person reaches only their own chats: an API key reaches the chats of the workspace owner, and an access token reaches the chats of the person who connected it. A key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
idstringRequiredThe chat id from
list.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
ChatResource with id, title, kind, messageCount and updatedAt.
Example
const chat = await nextmail.chats.get('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65') console.log(chat.title)Notes
An unknown id is a 404.
Also available in
- API
GET /chats/{id}- Python
chats.get()- Ruby
chats.get- PHP
chats->get- Go
Chats.Get- Java
chats().get- C#
Chats.GetAsync- CLI
openemail chats get
nextmail.chats.rename()
Rename a chat
rename(id: string, title: string, options?: RequestScope): Promise<ChatResource>Gives a chat with the assistant a new title, up to 120 characters, and resolves with the chat as it is now.
Each person reaches only their own chats: an API key reaches the chats of the workspace owner, and an access token reaches the chats of the person who connected it. A key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
idstringRequiredThe chat id from
list.titlestringRequiredThe new title, from 1 to 120 characters.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
ChatResource with the new title.
Example
await nextmail.chats.rename('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65', 'Quarterly invoices')Notes
An unknown id is a 404.
Also available in
nextmail.chats.delete()
Delete a chat
delete(id: string, options?: RequestScope): Promise<DeletedChatResource>Deletes a chat with the assistant and every message in it, for good. Nothing the assistant did in the mailbox is undone.
Each person reaches only their own chats: an API key reaches the chats of the workspace owner, and an access token reaches the chats of the person who connected it. A key or token limited to particular addresses or domains is 422 capability_unsupported.
Parameters
idstringRequiredThe chat id from
list.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Returns
DeletedChatResource with object: 'chat', the id and deleted: true.
Example
await nextmail.chats.delete('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65')Notes
An unknown id is a 404, and so is a second call for the same chat.
The SDK does not retry it.