Skip to content
Console
On this page

Mailboxes

A Mailbox is an email address Notify reads from and sends as.

A Mailbox is an email address Notify reads from and sends as. A CONNECTED mailbox is an existing mailbox at any provider, reached over IMAP (read only) and SMTP with its own login, either a password or an OAuth 2.0 grant (XOAUTH2) at Google or Microsoft; a HOSTED mailbox receives at an address whose MX is Sylphx. Mail it receives becomes Inbound Email records.

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

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/mailboxes/{mailbox}.
uidstringmbx_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specMailboxSpecDesired state. Required.
statusMailboxStatusObserved state. 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 a mailbox.
GETlistLists mailboxes.
POSTcreateCreates a mailbox.
PATCHupdateUpdates a mailbox.
DELETEdeleteDeletes a mailbox and its inbound email.
POSTerase_addressRemoves 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.

get

Gets a mailbox.

GET 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.

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

create

Creates a mailbox.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes · scope notify:write · effect write · Request, response and examples

update

Updates a mailbox.

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

delete

Deletes a mailbox and its inbound email.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox · scope notify:write · effect destructive · Request, response and examples

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.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes/mailbox:eraseAddress · scope notify:write · effect destructive · Request, response and examples