Перейти к документации
MCP-сервер

Подписки

Новостные рассылки и списки рассылки, которые получает почтовый ящик.

Инструменты подписок

ИнструментЧто делает
listSubscriptionsОтправители новостных рассылок и списков рассылки, по одной строке на отправителя и адрес, на который он пишет, с тем, сколько почты прислал каждый и как он позволяет отписаться.
listSubscriptionDomainsТо же самое, по одной строке на домен отправителя, с числом его отправителей, от которых можно отписаться без того, чтобы человек открывал страницу.
unsubscribeSubscriptionОтписаться от одного отправителя так, как он просит. Отправитель, который предлагает только страницу, возвращает ссылку на неё, чтобы её открыл человек.
unsubscribeSubscriptionDomainОтписаться от каждого отправителя домена, который принимает запрос в один щелчок или письмо, и посчитать остальных.
unsubscribeThreadОтписаться от отправителя цепочки, как это делает кнопка «Отменить подписку» в области чтения.
moveSubscriptionПереместить всё, что прислал отправитель, в архив, в корзину или под метку, а с future продолжать перемещать его новую почту с помощью правила.

Чтение требует «Read threads and messages» (threads:read), а отписка и перемещение требуют «Label, read and archive threads» (threads:write). Чтобы новая почта продолжала перемещаться, создаётся правило, которому также нужно «Create, edit and reorder mail rules» (rules:write). Клиент, ограниченный некоторыми адресами, достаёт только подписки, доставляемые на них.

Отписка посылает отправителю запрос или письмо, и ничто здесь её не отменяет. В чате приложения unsubscribeSubscriptionDomain всегда сначала спрашивает, а остальные изменения спрашивают, если только вы сами о них не попросили.

Справочник

listSubscriptions

Разрешенияthreads:readАссистент в приложении выполняет его без вопросовНабор инструментовsubscriptions

The newsletters and mailing lists the mailbox receives, as the Subscriptions page shows them: one row per sender and the address it writes to, with how much mail it sent, how much is unread and how it lets you unsubscribe. status is active (the default) or unsubscribed. query searches the sender, sort is recent, most, unread or name, and offset pages on.

Входные данные

statusstring
Одно из"active""unsubscribed"
querystring
До 200 символов
sortstring
Одно из"recent""most""unread""name"
limitinteger
Не меньше 1Не больше 200
offsetinteger
Не меньше 0
addressstring
От 3 до 320 символов

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

API
GET /subscriptions
SDK
subscriptions.list()

listSubscriptionDomains

Разрешенияthreads:readАссистент в приложении выполняет его без вопросовНабор инструментовsubscriptions

The same subscriptions grouped by sender domain, so a company that writes from several addresses is one row, with how many of its senders can be unsubscribed without a person opening a page. Takes the same filters as listSubscriptions.

Входные данные

statusstring
Одно из"active""unsubscribed"
querystring
До 200 символов
sortstring
Одно из"recent""most""unread""name"
limitinteger
Не меньше 1Не больше 200
offsetinteger
Не меньше 0
addressstring
От 3 до 320 символов

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

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

unsubscribeSubscription

Разрешенияthreads:writeАссистент в приложении сначала спрашивает, если вы сами об этом не попросилиНабор инструментовsubscriptions

Unsubscribe from one sender the way it asks for: a one-click request when it offers one, otherwise an unsubscribe email from the address the mail arrived at. A sender that only offers a page returns its link, which a person has to open. bin also moves every conversation from the sender to the Bin. Take the id from listSubscriptions.

Входные данные

idstringОбязательно
От 1 до 64 символов
binboolean

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

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

unsubscribeSubscriptionDomain

Разрешенияthreads:writeАссистент в приложении всегда сначала спрашиваетНабор инструментовsubscriptions

Unsubscribe from every sender on one domain that can be unsubscribed without a person opening a page, as the domain view of the Subscriptions page does. Senders that only offer a page are skipped and counted. bin also moves their conversations to the Bin, and address keeps it to the subscriptions delivered to one address.

Входные данные

domainstringОбязательно
От 1 до 253 символов
addressstring
От 3 до 320 символов
binboolean

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

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

unsubscribeThread

Разрешенияthreads:writeАссистент в приложении сначала спрашивает, если вы сами об этом не попросилиНабор инструментовsubscriptions

Unsubscribe from the sender of an email thread, as the Unsubscribe button of the reading pane does, from the newest message in it that carries an unsubscribe header.

Входные данные

threadIdstringОбязательно
От 1 до 200 символов

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

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

moveSubscription

Разрешенияthreads:writeАссистент в приложении сначала спрашивает, если вы сами об этом не попросилиНабор инструментовsubscriptions

Move every conversation from one sender to the archive, the Bin or a label. future, true by default, also makes a rule that keeps doing it to new mail from the sender, which needs permission to change rules, and false drops such a rule. labelId is the label for destination label, from getUserLabels.

Входные данные

idstringОбязательно
От 1 до 64 символов
destinationstringОбязательно
Одно из"archive""bin""label"
labelIdstring
От 1 до 200 символов
futureboolean
ruleNamestring
До 100 символов

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

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