list_inbound_items

bot.mailbox/mailbox · Verify this server

Search managed-renter physical mail through GET /v1/inbound-items?search_mode=documents. q uses literal AND terms across authorized saved metadata, exterior OCR and completed requested inside-page OCR (NFKC/lowercase, max 200 characters and 12 terms). Terms may match different pages of one item. received_after is inclusive and received_before exclusive; these filter intake time, never a printed letter date. status and kind narrow canonical item metadata. Sender/address terms use q; identify them from actual page evidence, not guessed fields. Returns item metadata and canonical owner/mailbox identity, not page text. Use get_inbound_item_sources for selected items. Saved-data reads only: no extraction, retry, signed image URL, facility action, provider call, email or charge. Exterior automation and authorized inside-page extraction have independent activation; these readers do not enable either. Limit 1–50 (default 25), offset 0–10000; follow pagination.has_more using offset plus returned count, stop at the cap and narrow query/date windows or report incomplete history. Results are not snapshot-consistent. Bound concurrency, honor Retry-After when present, back off on transient failures, and stop on access errors. No new exterior-ready webhook or unbounded export is promised. Requires saved-document reads enabled for the account, an active eligible managed mailbox, and both inbound.item.read and inbound.item.scan.read, even for empty searches. Live member keys are owner-scoped; Live agent keys see only their current assigned mail. No facility, Sandbox or package.read compatibility access. Stop on denial; never switch keys, accounts or mail APIs to bypass it. A member key cannot select agent duties; use get_mailbox_md separately with the intended agent's agent.read scope.