---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx notify mailboxes"
description: "The sylphx notify mailboxes commands of Sylphx Notify: every verb, with its argument, its flags and a run line."
type: reference
product: email
summary: "Every sylphx notify mailboxes command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `mailboxes` commands of Sylphx Notify, as the CLI spells them: the same
calls as [the `mailboxes` API page](/docs/api/mailboxes), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a mailbox.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx notify mailboxes get orgs/acme/projects/shop/envs/production/mailboxes/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.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx notify mailboxes list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/mailboxes/list)

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

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

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

```bash
sylphx notify mailboxes update orgs/acme/projects/shop/envs/production/mailboxes/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)

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

```bash
sylphx notify mailboxes delete orgs/acme/projects/shop/envs/production/mailboxes/mailbox --yes
```

`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)

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

```bash
sylphx notify mailboxes erase-address orgs/acme/projects/shop/envs/production/mailboxes/mailbox --yes
```

`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)

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