Python

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

def list(    *,    limit: int | None = None,    cursor: str | None = None,    q: str | None = None,    sort: ChatSort | None = None,    api_key: str | None = None,    timeout: float | None = None,) -> Page[ChatResource]

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

limitint: Page size, from 1 to 100. The server defaults to 25.
cursorstr: The nextCursor of the previous page. Leave it out for the first page.
qstr: Searches the titles.
sortChatSort: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
api_keystr: Overrides the client's API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

Returns

Page[ChatResource], a dict with items, hasMore and nextCursor. Each item has id, title, kind, messageCount and updatedAt.

Example

from openemail import openemail page = openemail.chats.list(q='invoices', limit=10) for chat in page['items']:    print(chat['title'], chat['messageCount'], chat['updatedAt']) print('More to read:', page['hasMore'])

Notes

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

Also available in

API: GET /chats
TypeScript: chats.list()
Ruby: chats.list
CLI: openemail chats list

`chats.list_all()`

Collect every chat into one list

threads:readPages through results

Signature

def list_all(    *,    limit: int | None = None,    cursor: str | None = None,    q: str | None = None,    sort: ChatSort | None = None,    api_key: str | None = None,    timeout: float | None = None,) -> builtins.list[ChatResource]

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

Parameters

limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstr: Starts the walk after this cursor instead of the first page.
qstr: Searches the titles.
sortChatSort: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
api_keystr: Overrides the client API key for every page of this walk.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

Returns

list[ChatResource] holding every chat.

Example

from openemail import openemail chats = openemail.chats.list_all() print(len(chats), 'chats holding', sum(chat['messageCount'] for chat in chats), 'messages')

Notes

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

Also available in

API: GET /chats
TypeScript: chats.listAll()
Ruby: chats.list_all

`chats.iterate()`

Stream the chats one at a time

threads:readPages through results

Signature

def iterate(    *,    limit: int | None = None,    cursor: str | None = None,    q: str | None = None,    sort: ChatSort | None = None,    api_key: str | None = None,    timeout: float | None = None,) -> Iterator[ChatResource]

Returns a 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 loop over it, and breaking out of the loop stops the requests.

Parameters

limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstr: Starts the walk after this cursor instead of the first page.
qstr: Searches the titles.
sortChatSort: newest (the default) or oldest by the last change, or title. A cursor carries on in the order it was handed out in.
api_keystr: Overrides the client API key for every page of this walk.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

Returns

Iterator[ChatResource], a generator yielding one chat per step.

Example

from openemail import openemail for chat in openemail.chats.iterate(sort='title'):    print(chat['title'], chat['messageCount'])

Notes

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

Also available in

API: GET /chats
TypeScript: chats.iterate()
Ruby: chats.iterate

`chats.get()`

Retrieve a chat

threads:read

Signature

def get(    id: str,    *,    api_key: str | None = None,    timeout: float | None = None,) -> ChatResource

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

Parameters

idstrRequired: The chat id from list.
api_keystr: Overrides the client's API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

Returns

ChatResource with id, title, kind, messageCount and updatedAt.

Example

from openemail import openemail chat = openemail.chats.get('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65') print(chat['title'], chat['messageCount'], chat['updatedAt'])

Notes

An unknown id is a 404.

Also available in

API: GET /chats/{id}
TypeScript: chats.get()
Ruby: chats.get
CLI: openemail chats get

`chats.rename()`

Rename a chat

threads:write

Signature

def rename(    id: str,    title: str,    *,    api_key: str | None = None,    timeout: float | None = None,) -> ChatResource

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

Parameters

idstrRequired: The chat id from list.
titlestrRequired: The new title, from 1 to 120 characters.
api_keystr: Overrides the client's API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

Returns

ChatResource with the new title.

Example

from openemail import openemail chat = openemail.chats.rename('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65', 'Quarterly invoices') print(chat['id'], chat['title'])

Notes

An unknown id is a 404.
Retried automatically on network failure, since the same title sent twice changes nothing.

Also available in

API: PATCH /chats/{id}
TypeScript: chats.rename()
Ruby: chats.rename
CLI: openemail chats rename

`chats.delete()`

Delete a chat

threads:write

Signature

def delete(    id: str,    *,    api_key: str | None = None,    timeout: float | None = None,) -> DeletedChatResource

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

Parameters

idstrRequired: The chat id from list.
api_keystr: Overrides the client's API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

Returns

DeletedChatResource with object set to chat, the id and deleted set to True.

Example

from openemail import OpenEmailApiError, openemail try:    removed = openemail.chats.delete('8f3c2a71-5e9d-4b06-a1c4-7d2e9f0b3a65')except OpenEmailApiError as error:    if not error.is_not_found:        raise     print('That chat is already gone')else:    print(removed['id'], removed['deleted'])

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()
Ruby: chats.delete
CLI: openemail chats delete

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