---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Mailboxes"
description: "The `mailboxes` collection of Sylphx Notify: A Mailbox is an email address Notify reads from and sends as."
type: reference
product: email
summary: "A Mailbox is an email address Notify reads from and sends as."
updated: 2026-09-28
order: 900
---

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; 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

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

## 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`](/docs/api/mailboxes#get) | Gets a mailbox. |
| `GET` | [`list`](/docs/api/mailboxes#list) | Lists mailboxes. |
| `POST` | [`create`](/docs/api/mailboxes#create) | Creates a mailbox. |
| `PATCH` | [`update`](/docs/api/mailboxes#update) | Updates a mailbox. |
| `DELETE` | [`delete`](/docs/api/mailboxes#delete) | Deletes a mailbox and its inbound email. |
| `POST` | [`erase_address`](/docs/api/mailboxes#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. |

## 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](/docs/api/mailboxes/get)

## 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](/docs/api/mailboxes/list)

## 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](/docs/api/mailboxes/create)

## 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](/docs/api/mailboxes/update)

## 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](/docs/api/mailboxes/delete)

## 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](/docs/api/mailboxes/erase_address)