messages

List received messages

Lists received mail in the inbox, newest first. Narrow it with query and the sender, recipient, subject, date and label filters, or order by oldest or relevance: see Find mail and labels. Follow next_cursor with the same filters and order for the next page (pagination).

A message is listed as soon as it arrives. Only entries with processing_status: "ready" have from and a preview, and thread_id stays null until then. Identify the sender by from, a parsed mailbox such as {"name":"Sender","address":"sender@example.com"} or a group such as {"name":"Team","group":[...]}; envelope_from is the SMTP sender and can be a bounce address.

Previews

Received and sent listings include preview, an excerpt of up to 300 characters, null until the message's content is ready. It starts from the new reply text when that can be extracted, so even an untruncated preview can leave out the rest of the body: read the message before acting on it.

get/v1/inboxes/{inbox_id}/messages

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/inboxes/{inbox_id}/messages
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

Cherami resource ID returned by the API.

Query parameters

limitinteger

Results per page.

cursorstring

next_cursor from the previous page. Keep the URL, filters and order unchanged.

querystring

Words or "quoted phrases" to find in the subject and body; every term must match. At most 16 terms and 512 UTF-16 code units. OR, NOT and wildcards have no special meaning, and attachments aren't searched. See Find mail.

fromstring

Bare sender address from the message headers, matched exactly without regard to case; not the SMTP envelope. At most 320 UTF-16 code units.

recipientstring

Bare recipient address from the message headers, matched exactly without regard to case; not the SMTP envelope. At most 320 UTF-16 code units.

subjectstring

Text the subject contains, matched literally without regard to case. At most 998 UTF-16 code units.

afterstring

Earliest (inclusive) receipt or send time, as an ISO 8601 instant with a timezone, such as 2026-10-01T00:00:00Z. after must be earlier than before. URL-encode it, including any + in an offset.

beforestring

Latest (exclusive) receipt or send time, as an ISO 8601 instant with a timezone, such as 2026-10-01T00:00:00Z. after must be earlier than before. URL-encode it, including any + in an offset.

labels_allLabel[]

Messages carrying every listed label. Repeat the parameter for each label rather than separating with commas. The three label groups combine with AND.

labels_anyLabel[]

Messages carrying at least one listed label. Repeat the parameter for each label rather than separating with commas. The three label groups combine with AND.

labels_noneLabel[]

Messages carrying none of the listed labels, unlabeled ones included. Repeat the parameter for each label rather than separating with commas. The three label groups combine with AND.

order'newest' | 'oldest' | 'relevance'

relevance requires query.

Response

Success.

next_cursorstring nullable required

Cursor for the next page, or null at the end. Send it with the same URL, filters and order.

Changes

No recorded changes to this operation across all 1 revision of this API.