---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create a mailbox"
description: "`notify.mailboxes.create` (POST /v1/{parent}/mailboxes): Creates a mailbox."
type: reference
product: email
summary: "Creates a mailbox."
updated: 2026-09-28
nav: false
---

Creates a mailbox.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes`
- **Scope** `notify:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [mailboxes](/docs/api/mailboxes)
- **Query** `mailbox_id`, `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to create in. Required. |
| `mailbox_id` | `string` | The mailbox id, the final name segment; the server assigns one when empty. |
| `mailbox` | `Mailbox` | The mailbox to create; only caller-writable fields are read. Required. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### Mailbox

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/mailboxes/{mailbox}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `MailboxSpec` | Desired state. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `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. |

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

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

## Response

| 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`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.
- [`PLAN_LIMIT_REACHED`](/docs/api/errors/PLAN_LIMIT_REACHED) — The plan's limit is reached.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailboxes" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"address":"…","kind":"connected"}}'
```

**TypeScript**

```ts
const response = await sylphx.notify.mailboxes.create({ mailbox: { spec: { address: '…', kind: 'connected' } }, parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::notify::CreateMailboxRequest::default();
req.mailbox = Some(sylphx::notify::Mailbox {
    spec: Some(sylphx::notify::MailboxSpec {
        address: "…".to_string(),
        kind: sylphx::notify::MailboxKind::Connected,
        ..Default::default()
    }),
    ..Default::default()
});
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let response = sx.notify().mailboxes().create(req).await?;
```

**CLI**

```bash
sylphx notify mailboxes create --parent orgs/acme/projects/shop/envs/production --spec.kind connected --spec.address …
```

**MCP**

```json
{ "method_id": "notify.mailboxes.create", "args": {"mailbox":{"spec":{"address":"…","kind":"connected"}},"parent":"orgs/acme/projects/shop/envs/production"} }
```