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

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

## get

Gets a mailbox connect link.

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

**CLI**

```bash
sylphx notify mailbox-connect-links get orgs/acme/projects/shop/envs/production/mailbox_connect_links/mailbox-connect-link
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_connect_links/mailbox-connect-link` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/mailbox_connect_links/get)

## list

Lists mailbox connect links.

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

**CLI**

```bash
sylphx notify mailbox-connect-links list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_connect_links` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/mailbox_connect_links/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

Mints a mailbox connect link for one end user; the response carries its `url`, which no later call returns.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx notify mailbox-connect-links create --parent orgs/acme/projects/shop/envs/production --provider google --return-url …
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/mailbox_connect_links` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/mailbox_connect_links/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. |
| `--provider` | `enum` | The provider whose consent the page opens; the environment needs that provider's Mailbox OAuth App. Required. One of `google`, `microsoft`. |
| `--mailbox` | `string` | The mailbox to reconnect, keeping its id and feed; it must be signed in as the same address. Empty creates a new connected mailbox. |
| `--mailbox-id` | `string` | The id of the new mailbox; the server assigns one when empty. |
| `--display-name` | `string` | The From display name of the new mailbox. |
| `--backfill-start-time` | `timestamp` | The new mailbox reads mail received on or after this day on its first poll. |
| `--login-hint` | `string` | The address to suggest on the consent screen (`login_hint`); the mailbox takes the address the provider confirms, whatever this says. |
| `--return-url` | `string` | Where the end user lands when done, HTTPS, with `connect_link={id}` and `result=connected` or `result=failed` added to the query. The query proves nothing: read the link back with your key for the outcome. Required. |
| `--refresh-url` | `string` | Where a claimed or expired link sends the end user, HTTPS; your server mints a new link there. Empty shows a page saying the link has expired. |
| `--ttl` | `duration` | How long the link stays open; default 1 hour, at most 7 days. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |