Перейти к документации
CLI

openemail subscriptions

Каждая команда этого пространства имён, с её аргументами, флагами и примерами.

Команды

The newsletters and mailing lists the mailbox receives: list them by sender or by domain, unsubscribe, and move what they send.

Каждая команда здесь также принимает глобальные флаги, например --json, --profile и --dry-run. Глобальные флаги

openemail subscriptions list

List subscriptions

Разрешенияthreads:readНужен входПсевдонимыls

Использование

openemail subscriptions list [flags]

Resolves the newsletters and mailing lists the mailbox receives, as the Subscriptions page of the app shows them: one row per sender and the address it writes to, found from the List-Unsubscribe header of the mail it sends. Each row says how much mail the sender sent, how much of it is unread and how much arrived in the last 30 days, how it lets you unsubscribe, and the rule that keeps moving its new mail when there is one.

status is active, the default, or unsubscribed. q searches the sender, and sort is recent, most, unread or name. Paging is by offset: total counts every match and hasMore says whether another page follows.

A key limited to particular addresses lists only the subscriptions delivered to them, and address narrows the list to one address.

Флаги

--status <value>

active or unsubscribed. Defaults to active.

По умолчанию"active"
--q <value>

Searches the sender name and address.

--sort <value>

recent, most, unread or name. Defaults to recent.

По умолчанию"recent"
--limit <n>

Rows per page, 1 to 200, defaulting to 50.

По умолчанию50
--offset <n>

How many rows to skip.

По умолчанию0
--address <value>

Only the subscriptions delivered to this address.

Примеры

openemail subscriptions list
With optional flags
openemail subscriptions list --sort most --limit 20
Print the raw JSON
openemail subscriptions list --json

Также доступно в

API
GET /subscriptions
SDK
subscriptions.list()

openemail subscriptions list-domains

List subscriptions by domain

Разрешенияthreads:readНужен вход

Использование

openemail subscriptions list-domains [flags]

Resolves the same subscriptions as list, one row per sender domain with the counts of its senders added up, so a company that writes from several addresses is one row. unsubscribable counts the senders on the domain that can be unsubscribed without a person opening a page, which is what unsubscribeDomain acts on.

It takes the same filters as list.

Флаги

--status <value>

active or unsubscribed. Defaults to active.

По умолчанию"active"
--q <value>

Searches the sender name and address.

--sort <value>

recent, most, unread or name. Defaults to recent.

По умолчанию"recent"
--limit <n>

Rows per page, 1 to 200, defaulting to 50.

По умолчанию50
--offset <n>

How many rows to skip.

По умолчанию0
--address <value>

Only the subscriptions delivered to this address.

Примеры

openemail subscriptions list-domains
With optional flags
openemail subscriptions list-domains --sort most
Print the raw JSON
openemail subscriptions list-domains --json

Также доступно в

API
GET /subscriptions/domains
SDK
subscriptions.listDomains()

openemail subscriptions unsubscribe

Unsubscribe from a sender

Разрешенияthreads:writeНужен вход
Просит подтверждения

Использование

openemail subscriptions unsubscribe <id> [flags]

Unsubscribes the way the sender asks for it: a one-click request to its unsubscribe address when it offers one, otherwise an unsubscribe email sent from the address the mail arrived at. A sender that only offers a page cannot be unsubscribed by a program, so method is link and url is the page a person has to open. bin also moves every conversation from the sender to the Bin.

A sender that gives no way to unsubscribe is a 422 unsubscribe_unsupported, and one whose one-click request failed with no address to write to is a 502 unsubscribe_refused. A subscription delivered to an address the key does not reach is a 404.

Аргументы

<id>Обязательно

The subscription, from list.

Флаги

--bin

Also move every conversation from the sender to the Bin. Defaults to false.

По умолчаниюfalse
--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Примеры

The required values only
openemail subscriptions unsubscribe sub_7d2c1f0a9b3e4c5d6e7f8a9b
With optional flags
openemail subscriptions unsubscribe sub_7d2c1f0a9b3e4c5d6e7f8a9b --bin
Skip the confirmation, for scripts
openemail subscriptions unsubscribe sub_7d2c1f0a9b3e4c5d6e7f8a9b --yes

Также доступно в

API
POST /subscriptions/{id}/unsubscribe
SDK
subscriptions.unsubscribe()

openemail subscriptions unsubscribe-domain

Unsubscribe from a whole domain

Разрешенияthreads:writeНужен вход
Просит подтверждения

Использование

openemail subscriptions unsubscribe-domain <domain> [flags]

Unsubscribes from every sender on a domain that can be unsubscribed without a person opening a page, with a one-click request or an unsubscribe email, as the domain view of the Subscriptions page does. unsubscribed counts the senders it worked for, skipped the senders that only offer a page and failed the ones that did not accept it.

bin also moves their conversations to the Bin, and address keeps it to the subscriptions delivered to one address. A key limited to particular addresses acts only on the subscriptions delivered to them.

Аргументы

<domain>Обязательно

The sender domain, from listDomains.

Флаги

--bin

Also move the conversations to the Bin. Defaults to false.

По умолчаниюfalse
--address <value>

Only the subscriptions delivered to this address.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Примеры

openemail subscriptions unsubscribe-domain news.acme.com
Skip the confirmation, for scripts
openemail subscriptions unsubscribe-domain news.acme.com --yes

Также доступно в

API
POST /subscriptions/domains/{domain}/unsubscribe
SDK
subscriptions.unsubscribeDomain()

openemail subscriptions move

Move what a sender sent

Разрешенияthreads:writeНужен вход

Использование

openemail subscriptions move <id> --destination <value> [flags]
openemail subscriptions move <id> --data <json|@file|-> [flags]

Moves every conversation from the sender to the archive, the Bin or a label, as the Subscriptions page does. destination is archive, bin or label, and label needs --label-id, or the call is a 422 label_not_found.

With future, the default, a rule keeps doing it to new mail from the sender to that address, which also needs rules:write. --rule-name names that rule. future: false drops a rule made that way before, when the key holds rules:write.

Аргументы

<id>Обязательно

The subscription, from list.

Флаги

--destination <value>

archive, bin or label. Required, here or in --data.

--label-id <value>

The label to file under, for label.

--future

Keep doing it to new mail with a rule. Defaults to true.

По умолчаниюtrue
--rule-name <value>

A name for that rule.

--data <json|@file|->

The whole body as JSON, inline, from a file with @path, or - for standard input. Flags override its keys.

Примеры

openemail subscriptions move sub_7d2c1f0a9b3e4c5d6e7f8a9b --destination archive
Read the whole body from a JSON file
openemail subscriptions move sub_7d2c1f0a9b3e4c5d6e7f8a9b --data @subscriptions.json

Также доступно в

API
POST /subscriptions/{id}/move
SDK
subscriptions.move()