اشتراک‌ها
هر عملیات در این گروه: آنچه می‌پذیرد، آنچه برمی‌گرداند و خطاهایی که ممکن است با آن‌ها پاسخ دهد.
عملیات‌ها
Newsletters and mailing lists the mailbox receives, found from the List-Unsubscribe header of the mail they send, as the Subscriptions page of the app shows them. Unsubscribe from one sender or a whole domain, or move what they sent and keep moving what they send.
GET/subscriptions
List subscriptions
One row per sender and address it writes to, with how much mail it sent, how much of it is unread and how much arrived in the last 30 days. A key or an app limited to particular addresses lists only the subscriptions delivered to them.
Requires the threads:read scope.
پارامترهای کوئری
statusstringactivelists what still arrives,unsubscribedwhat you left.یکی از"active""unsubscribed"پیش‌فرض"active"qstringSearches the sender name and address.
تا 200 نویسهsortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.یکی از"recent""most""unread""name"پیش‌فرض"recent"limitintegerRows per page.
دست‌کم 1حداکثر 200پیش‌فرض50offsetintegerHow many rows to skip, for the next page.
دست‌کم 0پیش‌فرض0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
3 تا 320 نویسه
خروجی
A page of subscriptions.
خطاها
خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها
همچنین در دسترس در
GET/subscriptions/domains
List subscriptions by domain
The same subscriptions, one row per sender domain with the counts of its senders added up, so a company that writes from several addresses is one row.
Requires the threads:read scope.
پارامترهای کوئری
statusstringactivelists what still arrives,unsubscribedwhat you left.یکی از"active""unsubscribed"پیش‌فرض"active"qstringSearches the sender name and address.
تا 200 نویسهsortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.یکی از"recent""most""unread""name"پیش‌فرض"recent"limitintegerRows per page.
دست‌کم 1حداکثر 200پیش‌فرض50offsetintegerHow many rows to skip, for the next page.
دست‌کم 0پیش‌فرض0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
3 تا 320 نویسه
خروجی
A page of sender domains.
خطاها
خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها
همچنین در دسترس در
POST/subscriptions/domains/{domain}/unsubscribe
Unsubscribe from a whole domain
Unsubscribes from every sender on the domain that can be unsubscribed without a person opening a page, with one-click or by email. skipped counts the senders that only offer a page, and failed the ones that did not accept it. Unsubscribing works the way the sender asks for it: a one-click request to its unsubscribe address when it offers one, an unsubscribe email from the address the mail arrived at when it gives a mailto, and otherwise the sender's own unsubscribe page in url, which a person has to open. method says which.
Requires the threads:write scope.
پارامترهای مسیر
domainstringالزامیThe sender domain, as
GET /subscriptions/domainsreturns it.
بدنهٔ درخواست
binbooleanAlso move every conversation from the senders to the Bin.
پیش‌فرضfalseaddressstringOnly the subscriptions delivered to this address.
3 تا 320 نویسه
خروجی
What happened to each sender, counted.
خطاها
خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها
همچنین در دسترس در
POST/subscriptions/{id}/unsubscribe
Unsubscribe from a sender
Unsubscribing works the way the sender asks for it: a one-click request to its unsubscribe address when it offers one, an unsubscribe email from the address the mail arrived at when it gives a mailto, and otherwise the sender's own unsubscribe page in url, which a person has to open. method says which. With bin, every conversation from the sender also moves to the Bin.
Requires the threads:write scope.
پارامترهای مسیر
idstringالزامیThe subscription, as
GET /subscriptionsreturns it.
بدنهٔ درخواست
binbooleanAlso move every conversation from the sender to the Bin.
پیش‌فرضfalse
خروجی
How it was unsubscribed.
خطاها
- 422
unsubscribe_unsupported: the sender gives no way to unsubscribe.- 502
unsubscribe_refused: the sender did not accept the one-click request and gives no address to write to.
خطاهایی که هر عملیاتی ممکن است برگرداند400401403404500فهرست خطاها
همچنین در دسترس در
POST/subscriptions/{id}/move
Move what a sender sent
Moves every conversation from the sender to the archive, the Bin or a label. With future, the default, a rule keeps doing it to new mail from the sender to that address, which also needs rules:write. future: false drops a rule made that way before.
Requires the threads:write scope.
پارامترهای مسیر
idstringالزامیThe subscription, as
GET /subscriptionsreturns it.
بدنهٔ درخواست
destinationstringالزامیarchive,binorlabel.یکی از"archive""bin""label"labelIdstringThe label to file under when
destinationislabel.می‌تواند null باشد1 تا 200 نویسهfuturebooleanAlso keep doing it to new mail from the sender, with a rule. Needs
rules:write.پیش‌فرضtrueruleNamestringA name for that rule.
می‌تواند null باشدتا 100 نویسه
خروجی
How many conversations moved, and the rule.
خطاها
خطاهایی که هر عملیاتی ممکن است برگرداند400401403404422500فهرست خطاها
همچنین در دسترس در
POST/threads/{id}/unsubscribe
Unsubscribe from the sender of a thread
The Unsubscribe button of the reading pane: finds the subscription behind the newest message of the thread that carries a List-Unsubscribe header and unsubscribes from it. Unsubscribing works the way the sender asks for it: a one-click request to its unsubscribe address when it offers one, an unsubscribe email from the address the mail arrived at when it gives a mailto, and otherwise the sender's own unsubscribe page in url, which a person has to open. method says which.
Requires the threads:write scope.
پارامترهای مسیر
idstringالزامیThe thread, as
GET /threadsreturns it.
خروجی
How it was unsubscribed.
خطاها
- 422
unsubscribe_unsupported: the sender gives no way to unsubscribe.- 502
unsubscribe_refused: the sender did not accept the one-click request and gives no address to write to.
خطاهایی که هر عملیاتی ممکن است برگرداند400401403404500فهرست خطاها
همچنین در دسترس در
اشیا
DomainUnsubscribeResultobject
objectstring- یکی از
"domain_unsubscribe" domainstringunsubscribedintegerskippedintegerSenders that only offer a page.
failedintegerbinnedinteger
Subscriptionobject
objectstring- یکی از
"subscription" idstringsenderEmailstringsenderNamestring- می‌تواند null باشد
recipientstringThe address the mail arrives at.
statusstring- یکی از
"active""unsubscribed" methodstringHow the sender lets you unsubscribe, or null when it gives no way.
می‌تواند null باشدیکی از"one-click""email""link"linkUrlstringIts unsubscribe page, when it has one.
می‌تواند null باشدunreadintegerrecentintegerMail in the last 30 days.
totalintegersinceUnsubscribedintegerMail that still arrived after you unsubscribed.
lastSeenAtstring- قالب
date-time unsubscribedAtstring- می‌تواند null باشدقالب
date-time unsubscribedWithstring- می‌تواند null باشدیکی از
"one-click""email""link" futureobjectThe rule that keeps moving its new mail, when there is one.
می‌تواند null باشدruleIdstringdestinationstring- یکی از
"archive""bin""label" labelIdstring- می‌تواند null باشد
SubscriptionDomainobject
objectstring- یکی از
"subscription_domain" domainstringnamestringsampleEmailstringOne sender address on the domain.
sendersintegerunsubscribableintegerSenders that can be unsubscribed without a person opening a page.
unreadintegerrecentintegertotalintegersinceUnsubscribedintegerlastSeenAtstring- قالب
date-time
SubscriptionDomainListobject
objectstring- یکی از
"list" totalintegercountsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionListobject
objectstring- یکی از
"list" dataSubscription[]totalintegerRows that match, across every page.
countsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionMoveResultobject
objectstring- یکی از
"subscription_move" subscriptionIdstringmovedintegerConversations moved.
ruleIdstringThe rule that keeps moving new mail.
می‌تواند null باشد
UnsubscribeResultobject
objectstring- یکی از
"unsubscribe" subscriptionIdstringthreadIdstringPresent when it was asked for through a thread.
methodstring- یکی از
"one-click""email""link" urlstringThe page to open when
methodislink, since that one needs a person.می‌تواند null باشدbinnedintegerConversations moved to the Bin.