Skip to content
Console
On this page

List inbound emails

Lists a mailbox's inbound email in feed order, oldest first.

Lists a mailbox's inbound email in feed order, oldest first.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox/inbound_emails
  • Scope notify:read
  • Effect read — nothing is written.
  • Collection inbound_emails
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries inbound_emails and, when there is more, next_page_token

Request

FieldTypeWhat it is
parentstringThe mailbox to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter over labels and filterable fields.
order_bystringAIP-132 ordering over filterable fields.

Response

FieldTypeWhat it is
inbound_emailsInboundEmail[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

InboundEmail

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/mailboxes/{mailbox}/inbound_emails/{inbound_email}.
uidstringieml_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
sequenceint64The feed position, increasing within the environment; filter sequence > N to resume after the last one handled. Output only.
directionInboundEmailDirectionReceived by the mailbox, or found in its Sent folder. Output only. One of received, sent.
message_idstringThe Message-ID without angle brackets; the dedupe key. Mail without one gets sha256-<hex>@invalid. Output only.
parent_message_idstringIn-Reply-To: the Message-ID this answers, without angle brackets. Output only.
referencesstring[]References, oldest first. Output only.
sender_addressstringThe From address, lower case. Output only.
sender_namestringThe From display name. Output only.
recipient_addressesstring[]The To addresses. Output only.
cc_addressesstring[]Cc addresses. Output only.
subjectstringThe subject. Output only.
text_bodystringThe plain-text body. Output only.
html_bodystringThe HTML body as received; render it only through a sanitizer. Output only.
receive_timetimestampThe Date header, else when the mailbox received it. Output only.
automatedboolSent by software: Auto-Submitted, Precedence bulk or list, auto-reply headers, or a delivery report. Output only.
raw_sha256stringSHA-256 of the raw message, hex. Output only.
size_bytesint64The raw message size. Output only.
erasedboolPersonal data removed by erasure; the dedupe key stays. Output only.
messagestringThe Notify Message that sent it, for mail Notify sent as this mailbox. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox/inbound_emails" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"