پرش به مستندات
سرور MCP

اشتراک‌ها

خبرنامه‌ها و فهرست‌های پستی‌ای که صندوق پستی دریافت می‌کند.

ابزارهای اشتراک‌ها

ابزارچه می‌کند
listSubscriptionsفرستندگان خبرنامه‌ها و فهرست‌های پستی، یک ردیف برای هر فرستنده و نشانی‌ای که به آن می‌نویسد، با اینکه هر کدام چقدر نامه فرستاده و چگونه اجازهٔ لغو اشتراک می‌دهد.
listSubscriptionDomainsهمان، یک ردیف برای هر دامنهٔ فرستنده، همراه با اینکه اشتراک چند فرستندهٔ آن را می‌شود بی‌آنکه کسی صفحه‌ای باز کند لغو کرد.
unsubscribeSubscriptionاشتراک یک فرستنده را به همان روشی که خودش می‌خواهد لغو کنید. فرستنده‌ای که فقط یک صفحه پیشنهاد می‌دهد پیوند آن را برمی‌گرداند تا یک نفر بازش کند.
unsubscribeSubscriptionDomainاشتراک هر فرستنده‌ای روی یک دامنه را که درخواست یک‌کلیکی یا ایمیل می‌پذیرد لغو کنید، و بقیه را بشمارید.
unsubscribeThreadاشتراک فرستندهٔ یک رشته را لغو کنید، همان کاری که دکمهٔ «لغو اشتراک» در پنل خواندن می‌کند.
moveSubscriptionهمهٔ آنچه یک فرستنده فرستاده را به بایگانی، سطل زباله یا یک برچسب ببرید، و با future نامه‌های تازه‌اش را با یک قاعده همچنان جابه‌جا کنید.

خواندن به «خواندن گفتگوها و پیام‌ها» (threads:read) نیاز دارد، و لغو اشتراک و جابه‌جا کردن به «برچسب‌زدن، خوانده‌شده کردن و بایگانی گفتگوها» (threads:write). ادامهٔ جابه‌جایی نامه‌های تازه یک قاعده می‌سازد، که به «ساختن، ویرایش و مرتب‌سازی دوبارهٔ قاعده‌های نامه» (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()