client.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. Only the workspace owner reaches them.

`Chats.List`

List the assistant chats

threads:readPages through results

Signature

List(ctx context.Context, opts ...openemail.RequestOption) (*openemail.Page, error)

Returns 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.

Only the workspace owner reaches the chats: an API key, or an access token the owner connected with every address. A token acting for a member is 403 owner_only, and a key or token limited to particular addresses or domains is 422 capability_unsupported.

Parameters

openemail.WithQstring: Searches the titles.
openemail.WithSortstring: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
openemail.WithLimitint: Page size, from 1 to 100. The server defaults to 25.
openemail.WithCursorstring: The NextCursor of the previous page. Leave it out for the first page.
openemail.WithAPIKeystring: Overrides the client's API key for this call only.

Returns

A *openemail.Page with Items, HasMore and NextCursor. Each item has id, title, kind, messageCount and updatedAt.

Example

page, err := client.Chats.List(ctx, openemail.WithQ("invoices"))if err != nil {	return err} for _, chat := range page.Items {	fmt.Println(chat.String("title"), chat.Int("messageCount"))} fmt.Println(page.HasMore, page.NextCursor)

Notes

A cursor that names nothing in this list is 400 invalid_cursor.

Also available in

API: GET /chats
TypeScript: chats.list()
Python: chats.list()
Ruby: chats.list
PHP: chats->list
Java: chats().list
C#: Chats.ListAsync
CLI: openemail chats list

`Chats.ListAll`

Collect every chat into one slice

threads:readPages through results

Signature

ListAll(ctx context.Context, opts ...openemail.RequestOption) ([]openemail.Object, error)

Walks every page of List and returns with every chat, in the order sort names. One request per page, with the same filters on each.

Parameters

openemail.WithQstring: Searches the titles.
openemail.WithSortstring: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
openemail.WithLimitint: Page size for each request, from 1 to 100. The server defaults to 25.
openemail.WithCursorstring: Starts the walk after this cursor instead of the first page.
openemail.WithAPIKeystring: Overrides the client API key for every page of this walk.

Returns

A []openemail.Object holding every chat.

Example

chats, err := client.Chats.ListAll(ctx)if err != nil {	return err} for _, chat := range chats {	fmt.Println(chat.String("id"), chat.String("object"))}

Notes

If any page fails the call fails and the rows already fetched are discarded.

Also available in

API: GET /chats
TypeScript: chats.listAll()
Python: chats.list_all()
Ruby: chats.list_all
PHP: chats->listAll
Java: chats().listAll
C#: Chats.ListAllAsync

`Chats.Iterate`

Stream the chats one at a time

threads:readPages through results

Signature

Iterate(ctx context.Context, opts ...openemail.RequestOption) *openemail.Iterator

Returns an iterator 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

openemail.WithQstring: Searches the titles.
openemail.WithSortstring: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
openemail.WithLimitint: Page size for each request, from 1 to 100. The server defaults to 25.
openemail.WithCursorstring: Starts the walk after this cursor instead of the first page.
openemail.WithAPIKeystring: Overrides the client API key for every page of this walk.

Returns

An *openemail.Iterator yielding one chat per step.

Example

for chat, err := range client.Chats.Iterate(ctx, openemail.WithSort("title")).All() {	if err != nil {		return err	} 	fmt.Println(chat.String("title"))}

Notes

Each page is one request, so a long walk makes many.

Also available in

API: GET /chats
TypeScript: chats.iterate()
Python: chats.iterate()
Ruby: chats.iterate
PHP: chats->iterate
Java: chats().iterate
C#: Chats.IterateAsync

`Chats.Get`

Retrieve a chat

threads:read

Signature

Get(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

Returns one chat with the assistant by its id: its title, how many messages it holds and when it last changed.

Parameters

idstringRequired: The chat id from List.
openemail.WithAPIKeystring: Overrides the client's API key for this call only.

Returns

An openemail.Object with id, title, kind, messageCount and updatedAt.

Example

chat, err := client.Chats.Get(ctx, "8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65")if err != nil {	return err} fmt.Println(chat.String("title"))

Notes

An unknown id is a 404.

Also available in

API: GET /chats/{id}
TypeScript: chats.get()
Python: chats.get()
Ruby: chats.get
PHP: chats->get
Java: chats().get
C#: Chats.GetAsync
CLI: openemail chats get

`Chats.Rename`

Rename a chat

threads:write

Signature

Rename(ctx context.Context, id string, title string, opts ...openemail.RequestOption) (openemail.Object, error)

Gives a chat with the assistant a new title, up to 120 characters, and returns with the chat as it is now.

Parameters

idstringRequired: The chat id from List.
titlestringRequired: The new title, from 1 to 120 characters.
openemail.WithAPIKeystring: Overrides the client's API key for this call only.

Returns

An openemail.Object with the new title.

Example

chat, err := client.Chats.Rename(ctx, "8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65", "Quarterly invoices")if err != nil {	return err} fmt.Println(chat.String("id"), chat.String("object"))

Notes

An unknown id is a 404.

Also available in

API: PATCH /chats/{id}
TypeScript: chats.rename()
Python: chats.rename()
Ruby: chats.rename
PHP: chats->rename
Java: chats().rename
C#: Chats.RenameAsync
CLI: openemail chats rename

`Chats.Delete`

Delete a chat

threads:write

Signature

Delete(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

Deletes a chat with the assistant and every message in it, for good. Nothing the assistant did in the mailbox is undone.

Parameters

idstringRequired: The chat id from List.
openemail.WithAPIKeystring: Overrides the client's API key for this call only.

Returns

An openemail.Object with object: 'chat', the id and deleted: true.

Example

chat, err := client.Chats.Delete(ctx, "8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65")if err != nil {	return err} fmt.Println(chat.String("id"), chat.String("object"))

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}
TypeScript: chats.delete()
Python: chats.delete()
Ruby: chats.delete
PHP: chats->delete
Java: chats().delete
C#: Chats.DeleteAsync
CLI: openemail chats delete

client.Chats

Methods

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Your inbox,on your own terms.

Your inbox,
on your own terms.