Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx notify mailboxes
Every sylphx notify mailboxes command: its argument, its flags and a run line.
The mailboxes commands of Sylphx Notify, as the CLI spells them: the same
calls as the mailboxes API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a mailbox.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify mailboxes get orgs/acme/projects/shop/envs/production/mailboxes/mailboxGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox · scope notify:read · effect read · Request, response and examples
#list
Lists mailboxes.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx notify mailboxes list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes · scope notify:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | 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. |
#create
Creates a mailbox.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx notify mailboxes create --parent orgs/acme/projects/shop/envs/production --spec.kind connected --spec.address …POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes · scope notify:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.kind | enum | Connected or hosted. Required. One of connected, hosted. |
--spec.address | string | The address, for example support@example.com. Required. |
--spec.display-name | string | The From display name of mail sent as this mailbox. |
--spec.imap.host | string | The host name. |
--spec.imap.port | int | The port; IMAP 993 and SMTP 465 when unset. |
--spec.imap.username | string | The login user; the mailbox address when unset. |
--spec.imap.security | enum | How the connection is secured. One of tls, starttls. |
--spec.smtp.host | string | The host name. |
--spec.smtp.port | int | The port; IMAP 993 and SMTP 465 when unset. |
--spec.smtp.username | string | The login user; the mailbox address when unset. |
--spec.smtp.security | enum | How the connection is secured. One of tls, starttls. |
--spec.password | string | The login password of both servers; write-only, sealed at rest. The value is never returned. |
--spec.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. |
--spec.backfill-start-time | timestamp | Read mail received on or after this day on the first poll. |
--spec.enabled | bool | Poll and send; a disabled mailbox keeps its records. |
--spec.auth-kind | enum | How a connected mailbox logs in to both servers; unset means PASSWORD. One of password, oauth. |
--spec.oauth-provider | enum | The OAuth provider, for OAUTH; the environment's Mailbox OAuth App of this provider is the client the grant belongs to. With imap or smtp unset the provider's own servers are used: Google imap.gmail.com:993 and smtp.gmail.com:465, Microsoft outlook.office365.com:993 and smtp.office365.com:587 (STARTTLS). One of google, microsoft. |
--spec.oauth-refresh-token | string | The OAuth refresh token, for OAUTH; write-only, sealed at rest like the password, never returned. A connect link sets it without the caller ever holding it; a caller that ran its own consent may set it directly, when the token was issued to the environment's Mailbox OAuth App. The value is never returned. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates a mailbox.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify mailboxes update orgs/acme/projects/shop/envs/production/mailboxes/mailboxPATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox · scope notify:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.display-name | string | The From display name of mail sent as this mailbox. |
--spec.imap.host | string | The host name. |
--spec.imap.port | int | The port; IMAP 993 and SMTP 465 when unset. |
--spec.imap.username | string | The login user; the mailbox address when unset. |
--spec.imap.security | enum | How the connection is secured. One of tls, starttls. |
--spec.smtp.host | string | The host name. |
--spec.smtp.port | int | The port; IMAP 993 and SMTP 465 when unset. |
--spec.smtp.username | string | The login user; the mailbox address when unset. |
--spec.smtp.security | enum | How the connection is secured. One of tls, starttls. |
--spec.password | string | The login password of both servers; write-only, sealed at rest. The value is never returned. |
--spec.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. |
--spec.backfill-start-time | timestamp | Read mail received on or after this day on the first poll. |
--spec.enabled | bool | Poll and send; a disabled mailbox keeps its records. |
--spec.auth-kind | enum | How a connected mailbox logs in to both servers; unset means PASSWORD. One of password, oauth. |
--spec.oauth-provider | enum | The OAuth provider, for OAUTH; the environment's Mailbox OAuth App of this provider is the client the grant belongs to. With imap or smtp unset the provider's own servers are used: Google imap.gmail.com:993 and smtp.gmail.com:465, Microsoft outlook.office365.com:993 and smtp.office365.com:587 (STARTTLS). One of google, microsoft. |
--spec.oauth-refresh-token | string | The OAuth refresh token, for OAUTH; write-only, sealed at rest like the password, never returned. A connect link sets it without the caller ever holding it; a caller that ran its own consent may set it directly, when the token was issued to the environment's Mailbox OAuth App. The value is never returned. |
--allow-missing | bool | Create the mailbox when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a mailbox and its inbound email.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify mailboxes delete orgs/acme/projects/shop/envs/production/mailboxes/mailbox --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox · scope notify:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the mailbox does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--force | bool | Delete its inbound email with it; a mailbox holding inbound email is not deleted without it. |
--yes | bool | Do not ask before this destructive call. |
#erase-address
Removes an address's personal data from every inbound email of the mailbox that it sent or that names it, keeping the dedupe keys so a poll never brings the mail back.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx notify mailboxes erase-address orgs/acme/projects/shop/envs/production/mailboxes/mailbox --yesPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox:eraseAddress · scope notify:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--address | string | The email address whose data is removed. Required. |
--yes | bool | Do not ask before this destructive call. |