--- title: "nextmail.chats" description: "Every method in this namespace: its signature, its parameters, what it returns and an example." url: "https://nextmail.sh/docs/sdk/reference/chats" area: "TypeScript" category: "Reference" --- # 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 ```ts list(options?: ChatListOptions): Promise> ``` 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`. Scopes: `threads:read`. **Parameters** - `options.q` (`string`): Searches the titles. - `options.sort` (`ChatSort`): `newest` (the default) or `oldest` by the last change, or `title`. A cursor carries on in the order it was handed out in. - `options.limit` (`number`): Page size, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): The `nextCursor` of the previous page. Leave it out for the first page. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `Page` with `items`, `hasMore` and `nextCursor`. Each item has `id`, `title`, `kind`, `messageCount` and `updatedAt`. **Example** ```ts 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`](https://nextmail.sh/docs/api/reference/chats#get-chats); Python [`chats.list()`](https://nextmail.sh/docs/python/reference/chats#list); Ruby [`chats.list`](https://nextmail.sh/docs/ruby/reference/chats#list); PHP [`chats->list`](https://nextmail.sh/docs/php/reference/chats#list); Go [`Chats.List`](https://nextmail.sh/docs/go/reference/chats#list); Java [`chats().list`](https://nextmail.sh/docs/java/reference/chats#list); C# [`Chats.ListAsync`](https://nextmail.sh/docs/csharp/reference/chats#list); CLI [`nextmail chats list`](https://nextmail.sh/docs/cli/reference/chats#chats-list). ### `nextmail.chats.listAll()` Collect every chat into one array ```ts listAll(options?: ChatListOptions): Promise> ``` 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. Scopes: `threads:read`. **Parameters** - `options.q` (`string`): Searches the titles. - `options.sort` (`ChatSort`): `newest` (the default) or `oldest` by the last change, or `title`. A cursor carries on in the order it was handed out in. - `options.limit` (`number`): Page size for each request, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): Starts the walk after this cursor instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it. - `options.apiKey` (`string`): Overrides the client API key for every page of this walk. **Returns** `Array` holding every chat. **Example** ```ts 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: API [`GET /chats`](https://nextmail.sh/docs/api/reference/chats#get-chats); Python [`chats.list_all()`](https://nextmail.sh/docs/python/reference/chats#listAll); Ruby [`chats.list_all`](https://nextmail.sh/docs/ruby/reference/chats#listAll); PHP [`chats->listAll`](https://nextmail.sh/docs/php/reference/chats#listAll); Go [`Chats.ListAll`](https://nextmail.sh/docs/go/reference/chats#listAll); Java [`chats().listAll`](https://nextmail.sh/docs/java/reference/chats#listAll); C# [`Chats.ListAllAsync`](https://nextmail.sh/docs/csharp/reference/chats#listAll). ### `nextmail.chats.iterate()` Stream the chats one at a time ```ts iterate(options?: ChatListOptions): AsyncGenerator ``` 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. Scopes: `threads:read`. **Parameters** - `options.q` (`string`): Searches the titles. - `options.sort` (`ChatSort`): `newest` (the default) or `oldest` by the last change, or `title`. A cursor carries on in the order it was handed out in. - `options.limit` (`number`): Page size for each request, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): Starts the walk after this cursor instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it. - `options.apiKey` (`string`): Overrides the client API key for every page of this walk. **Returns** `AsyncGenerator` yielding one chat per step. **Example** ```ts 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: API [`GET /chats`](https://nextmail.sh/docs/api/reference/chats#get-chats); Python [`chats.iterate()`](https://nextmail.sh/docs/python/reference/chats#iterate); Ruby [`chats.iterate`](https://nextmail.sh/docs/ruby/reference/chats#iterate); PHP [`chats->iterate`](https://nextmail.sh/docs/php/reference/chats#iterate); Go [`Chats.Iterate`](https://nextmail.sh/docs/go/reference/chats#iterate); Java [`chats().iterate`](https://nextmail.sh/docs/java/reference/chats#iterate); C# [`Chats.IterateAsync`](https://nextmail.sh/docs/csharp/reference/chats#iterate). ### `nextmail.chats.get()` Retrieve a chat ```ts get(id: string, options?: RequestScope): Promise ``` 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`. Scopes: `threads:read`. **Parameters** - `id` (`string`, required): The chat id from `list`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `ChatResource` with `id`, `title`, `kind`, `messageCount` and `updatedAt`. **Example** ```ts 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}`](https://nextmail.sh/docs/api/reference/chats#get-chats-id); Python [`chats.get()`](https://nextmail.sh/docs/python/reference/chats#get); Ruby [`chats.get`](https://nextmail.sh/docs/ruby/reference/chats#get); PHP [`chats->get`](https://nextmail.sh/docs/php/reference/chats#get); Go [`Chats.Get`](https://nextmail.sh/docs/go/reference/chats#get); Java [`chats().get`](https://nextmail.sh/docs/java/reference/chats#get); C# [`Chats.GetAsync`](https://nextmail.sh/docs/csharp/reference/chats#get); CLI [`nextmail chats get`](https://nextmail.sh/docs/cli/reference/chats#chats-get). ### `nextmail.chats.rename()` Rename a chat ```ts rename(id: string, title: string, options?: RequestScope): Promise ``` 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`. Scopes: `threads:write`. **Parameters** - `id` (`string`, required): The chat id from `list`. - `title` (`string`, required): The new title, from 1 to 120 characters. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `ChatResource` with the new `title`. **Example** ```ts await nextmail.chats.rename('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65', 'Quarterly invoices') ``` **Notes** - An unknown id is a 404. Also available in: API [`PATCH /chats/{id}`](https://nextmail.sh/docs/api/reference/chats#patch-chats-id); Python [`chats.rename()`](https://nextmail.sh/docs/python/reference/chats#rename); Ruby [`chats.rename`](https://nextmail.sh/docs/ruby/reference/chats#rename); PHP [`chats->rename`](https://nextmail.sh/docs/php/reference/chats#rename); Go [`Chats.Rename`](https://nextmail.sh/docs/go/reference/chats#rename); Java [`chats().rename`](https://nextmail.sh/docs/java/reference/chats#rename); C# [`Chats.RenameAsync`](https://nextmail.sh/docs/csharp/reference/chats#rename); CLI [`nextmail chats rename`](https://nextmail.sh/docs/cli/reference/chats#chats-rename). ### `nextmail.chats.delete()` Delete a chat ```ts delete(id: string, options?: RequestScope): Promise ``` 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`. Scopes: `threads:write`. **Parameters** - `id` (`string`, required): The chat id from `list`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DeletedChatResource` with `object: 'chat'`, the `id` and `deleted: true`. **Example** ```ts 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. Also available in: API [`DELETE /chats/{id}`](https://nextmail.sh/docs/api/reference/chats#delete-chats-id); Python [`chats.delete()`](https://nextmail.sh/docs/python/reference/chats#delete); Ruby [`chats.delete`](https://nextmail.sh/docs/ruby/reference/chats#delete); PHP [`chats->delete`](https://nextmail.sh/docs/php/reference/chats#delete); Go [`Chats.Delete`](https://nextmail.sh/docs/go/reference/chats#delete); Java [`chats().delete`](https://nextmail.sh/docs/java/reference/chats#delete); C# [`Chats.DeleteAsync`](https://nextmail.sh/docs/csharp/reference/chats#delete); CLI [`nextmail chats delete`](https://nextmail.sh/docs/cli/reference/chats#chats-delete).