تخطَّ إلى المستندات
خادم 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()