List inboxes
cooper_list_inboxesUse this when you need to know which inboxes exist on the signed-in account, for example to pick an inbox_id before sending or reading mail, or to tell the user their address. Read-only; requires auth. Inputs: status (optional; active or paused; omit to list every inbox), q (optional case-insensitive substring of email, username, or display_name; prefix matches come first), label (optional exact label), limit (optional; default 100, maximum 500), page_token (optional cursor). Returns {data:[{id, username, email, display_name, created_at, require_sender_auth, labels, expires_at, status, paused_at, metadata, client_id}], next_page_token}. A limit outside 1 to 500 returns HTTP 400 invalid_limit. A bad page_token returns HTTP 400 invalid_page_token. An unknown status returns 400 invalid_status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Optional case-insensitive substring of email, username, or display_name. Prefix matches are listed first. % and _ match those characters. | |
| label | No | Optional exact label. Only inboxes that carry this label are returned. | |
| limit | No | Page size. Default 100. Maximum 500. Outside 1 to 500 returns invalid_limit. | |
| status | No | Optional filter. active or paused. Omit to list every inbox. | |
| page_token | No | Cursor from next_page_token. A bad token returns invalid_page_token. |