ドキュメント本文へスキップ
CLI

openemail dns-connections

この名前空間のすべてのコマンドと、その引数、フラグ、例。

コマンド

The DNS provider accounts connected to the workspace, through which OpenEmail writes the records of a domain itself: list them, read what disconnecting one would leave behind, and disconnect it. Connecting one is done in the app, because the provider asks the person to sign in.

ここのすべてのコマンドは、--json、--profile、--dry-run などのグローバルフラグも受け付けます。 グローバルフラグを見る

openemail dns-connections list

List the DNS provider accounts connected to the workspace

スコープdomains:readサインインが必要エイリアスls

使い方

openemail dns-connections list [flags]

Returns every DNS provider account connected to the workspace, through which OpenEmail writes the records of a domain itself, as the Providers tab of the domains page in the app shows them. Each one names the domains it serves, how many records OpenEmail wrote through it and still keeps, and whether it is active, needs connecting again (needs-reauth) or was disconnected (revoked).

configured is false when this server cannot connect a provider at all. A connection is made in the app, because the provider asks the person to sign in, so there is no method to create one.

例

openemail dns-connections list
Print the raw JSON
openemail dns-connections list --json

ほかの提供先

API
GET /dns-connections
SDK
dnsConnections.list()

openemail dns-connections get

Read a DNS connection and what disconnecting it would leave behind

スコープdomains:readサインインが必要エイリアスshowview

使い方

openemail dns-connections get <id> [flags]

Returns one connection with what disconnecting it would do: the domains it serves, the records OpenEmail wrote through it, busy for the domains a sync is running on right now, which hold a disconnect back until it ends, and keepsMail for the verified domains that stop receiving mail once their records come down.

引数

<id>必須

A connection id from list.

例

openemail dns-connections get dnsl_3f9a1c2e7b4d4e6f8a0b2c3d
Print the raw JSON
openemail dns-connections get dnsl_3f9a1c2e7b4d4e6f8a0b2c3d --json

ほかの提供先

API
GET /dns-connections/{id}
SDK
dnsConnections.get()

openemail dns-connections delete

Disconnect a DNS provider account

スコープdomains:writeサインインが必要
確認を求めます
エイリアスrmdelremove

使い方

openemail dns-connections delete <id> [flags]

Disconnects the account as Disconnect does in the app: the records OpenEmail wrote through it come down, every domain it serves is detached, and the connection is revoked at the provider. A verified domain whose records come down stops receiving mail, so read get first. detached counts what came down and lists the records still published, to delete by hand.

A connection that is already disconnected is removed from the list instead, once no domain and no record is left on it, and removed says so.

引数

<id>必須

A connection id from list.

例

openemail dns-connections delete dnsl_3f9a1c2e7b4d4e6f8a0b2c3d
Skip the confirmation, for scripts
openemail dns-connections delete dnsl_3f9a1c2e7b4d4e6f8a0b2c3d --yes

ほかの提供先

API
DELETE /dns-connections/{id}
SDK
dnsConnections.delete()