Skip to main content

List Quarantined Inbound Mail

GET 
/api/support/agent/inbound-mail

Lists the email quarantine: messages that reached the support intake but did not become a ticket or a reply. Newest first.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

status is one of:

  • unknown_sender — the sender's address is not a SKU.io user (they were told once, politely, to use the app)
  • unverified — the sender's address failed email authentication (SPF, DKIM or DMARC), so it was never matched to a user
  • bounce — a delivery-failure report for one of our own outbound mails; ticket_id points at the ticket whose mail bounced when the report quoted our message id
  • ignored — an auto-reply or other mail that was deliberately not processed
  • failed — processing the message raised an error
  • processing — a worker claimed the message but never recorded an outcome. A claim holds a lease of 60 seconds (configurable per deployment); a row still processing past its lease is a crashed delivery and is listed here so it is visible rather than silently stuck. The next redelivery of the same message takes the row over (its note becomes reclaimed after a stale processing lease). Rows still within their lease are not listed.

note explains the outcome where there is more to say. Mail that did become a ticket or reply, and duplicates, are not listed.

Filtering: filter[search] matches the sender, subject, note, Message-ID and ticket reference at once; search_columns narrows it to named fields and search_strict_columns makes those fields match exactly. filter[status] takes one status or a comma-separated set (all narrows nothing) and filter[created_at] takes a day or a from,to range. Every column can also be filtered with an operator suffix — filter[<column>.<operator>], e.g. filter[subject.starts_with]=Re:. filter_groups expresses AND/OR and nested combinations.

Sorting: sort accepts id, created_at, from, subject, status, note and ticket_id, prefixed with - for descending. The default order is -created_at, then -id.

Pagination: standard pagination envelope — data plus current_page, last_page, per_page, total, from, to and the page links. per_page defaults to 10 and is capped at 100.

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role.

Request​

Responses​

OK

Response Headers
    Content-Type