الاشتراكات
كل عملية في هذه المجموعة: ما تقبله وما تُرجعه والأخطاء التي قد تردّ بها.
العمليات
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.
يمكن أن يكون nullunreadintegerrecentintegerMail 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.
يمكن أن يكون nullruleIdstringdestinationstring- أحد
"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.يمكن أن يكون nullbinnedintegerConversations moved to the Bin.