Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/mailboxes/{mailbox}/inbound_emails/{inbound_email}. |
uid | string | ieml_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
sequence | int64 | The feed position, increasing within the environment; filter sequence > N to resume after the last one handled. Output only. |
direction | InboundEmailDirection | Received by the mailbox, or found in its Sent folder. Output only. One of received, sent. |
message_id | string | The Message-ID without angle brackets; the dedupe key. Mail without one gets sha256-<hex>@invalid. Output only. |
parent_message_id | string | In-Reply-To: the Message-ID this answers, without angle brackets. Output only. |
references | string[] | References, oldest first. Output only. |
sender_address | string | The From address, lower case. Output only. |
sender_name | string | The From display name. Output only. |
recipient_addresses | string[] | The To addresses. Output only. |
cc_addresses | string[] | Cc addresses. Output only. |
subject | string | The subject. Output only. |
text_body | string | The plain-text body. Output only. |
html_body | string | The HTML body as received; render it only through a sanitizer. Output only. |
receive_time | timestamp | The Date header, else when the mailbox received it. Output only. |
automated | bool | Sent by software: Auto-Submitted, Precedence bulk or list, auto-reply headers, or a delivery report. Output only. |
raw_sha256 | string | SHA-256 of the raw message, hex. Output only. |
size_bytes | int64 | The raw message size. Output only. |
erased | bool | Personal data removed by erasure; the dedupe key stays. Output only. |
message | string | The 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets an inbound email. |
GET | list | Lists 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