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
On this page
Get an inbound email
Gets an inbound email.
Gets an inbound email.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox/inbound_emails/inbound-email - Scope
notify:read - Effect
read— nothing is written. - Collection inbound_emails
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the inbound email to get. Required. |
#Response
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong 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_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
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/inbound-email" \
-H "Authorization: Bearer $SYLPHX_API_KEY"