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
List mailboxes
Lists mailboxes.
Lists mailboxes.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes - Scope
notify:read - Effect
read— nothing is written. - Collection mailboxes
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
mailboxesand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter over labels and filterable fields. |
order_by | string | AIP-132 ordering over filterable fields. |
#Response
| Field | Type | What it is |
|---|---|---|
mailboxes | Mailbox[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#Mailbox
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/mailboxes/{mailbox}. |
uid | string | mbx_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | MailboxSpec | Desired state. Required. |
status | MailboxStatus | Observed state. 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. |
#MailboxSpec
| Field | Type | What it is |
|---|---|---|
kind | MailboxKind | Connected or hosted. Required. One of connected, hosted. |
address | string | The address, for example support@example.com. Required. |
display_name | string | The From display name of mail sent as this mailbox. |
imap | MailServer | IMAP, for a connected mailbox. |
smtp | MailServer | SMTP submission, for a connected mailbox. |
password | string | The login password of both servers; write-only, sealed at rest. Never returned again. |
append_sent | bool | Save a copy of mail sent as this mailbox to its Sent folder (IMAP APPEND); off when the provider saves one itself. |
backfill_start_time | timestamp | Read mail received on or after this day on the first poll. |
enabled | bool | Poll and send; a disabled mailbox keeps its records. |
#MailboxStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
password_set | bool | Whether a password is stored. Output only. |
last_poll_time | timestamp | When the mailbox was last read. Output only. |
last_error | string | The last poll's error; empty after a clean poll. Output only. |
sent_folder | string | The Sent folder found on the server. Output only. |
#MailServer
| Field | Type | What it is |
|---|---|---|
host | string | The host name. Required. |
port | int32 | The port; IMAP 993 and SMTP 465 when unset. |
username | string | The login user; the mailbox address when unset. |
security | MailServerSecurity | How the connection is secured. One of tls, starttls. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes" \
-H "Authorization: Bearer $SYLPHX_API_KEY"