Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Inbound emails

An Inbound Email is one mail a mailbox holds, received or sent, kept as evidence: parsed once, never changed except by erasure.

An Inbound Email is one mail a mailbox holds, received or sent, kept as evidence: parsed once, never changed except by erasure. Consumers read the feed in sequence order.

Service Sylphx Notify · Resource type notify.sylphx.com/InboundEmail · Name pattern orgs/{org}/projects/{project}/envs/{env}/mailboxes/{mailbox}/inbound_emails/{inbound_email} · Shape record

#Fields

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.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets an inbound email.
GETlistLists a mailbox's inbound email in feed order, oldest first.

#get

Gets an inbound email.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox/inbound_emails/inbound-email · scope notify:read · effect read · Request, response and examples

#list

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

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox/inbound_emails · scope notify:read · effect read · paginated · Request, response and examples