Abonelikler
Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.
İşlemler
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.
Sorgu parametreleri
statusstringactivelists what still arrives,unsubscribedwhat you left.Şunlardan biri"active""unsubscribed"Varsayılan"active"qstringSearches the sender name and address.
En çok 200 karaktersortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.Şunlardan biri"recent""most""unread""name"Varsayılan"recent"limitintegerRows per page.
En az 1En çok 200Varsayılan50offsetintegerHow many rows to skip, for the next page.
En az 0Varsayılan0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
3 ile 320 karakter arası
Döndürür
A page of subscriptions.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Sorgu parametreleri
statusstringactivelists what still arrives,unsubscribedwhat you left.Şunlardan biri"active""unsubscribed"Varsayılan"active"qstringSearches the sender name and address.
En çok 200 karaktersortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.Şunlardan biri"recent""most""unread""name"Varsayılan"recent"limitintegerRows per page.
En az 1En çok 200Varsayılan50offsetintegerHow many rows to skip, for the next page.
En az 0Varsayılan0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
3 ile 320 karakter arası
Döndürür
A page of sender domains.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
domainstringZorunluThe sender domain, as
GET /subscriptions/domainsreturns it.
İstek gövdesi
binbooleanAlso move every conversation from the senders to the Bin.
VarsayılanfalseaddressstringOnly the subscriptions delivered to this address.
3 ile 320 karakter arası
Döndürür
What happened to each sender, counted.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe subscription, as
GET /subscriptionsreturns it.
İstek gövdesi
binbooleanAlso move every conversation from the sender to the Bin.
Varsayılanfalse
Döndürür
How it was unsubscribed.
Hatalar
- 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.
Her işlemin döndürebileceği hatalar400401403404500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe subscription, as
GET /subscriptionsreturns it.
İstek gövdesi
destinationstringZorunluarchive,binorlabel.Şunlardan biri"archive""bin""label"labelIdstringThe label to file under when
destinationislabel.null olabilir1 ile 200 karakter arasıfuturebooleanAlso keep doing it to new mail from the sender, with a rule. Needs
rules:write.VarsayılantrueruleNamestringA name for that rule.
null olabilirEn çok 100 karakter
Döndürür
How many conversations moved, and the rule.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe thread, as
GET /threadsreturns it.
Döndürür
How it was unsubscribed.
Hatalar
- 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.
Her işlemin döndürebileceği hatalar400401403404500Hata kataloğu
Şurada da var
Nesneler
DomainUnsubscribeResultobject
objectstring- Şunlardan biri
"domain_unsubscribe" domainstringunsubscribedintegerskippedintegerSenders that only offer a page.
failedintegerbinnedinteger
Subscriptionobject
objectstring- Şunlardan biri
"subscription" idstringsenderEmailstringsenderNamestring- null olabilir
recipientstringThe address the mail arrives at.
statusstring- Şunlardan biri
"active""unsubscribed" methodstringHow the sender lets you unsubscribe, or null when it gives no way.
null olabilirŞunlardan biri"one-click""email""link"linkUrlstringIts unsubscribe page, when it has one.
null olabilirunreadintegerrecentintegerMail in the last 30 days.
totalintegersinceUnsubscribedintegerMail that still arrived after you unsubscribed.
lastSeenAtstring- Biçim
date-time unsubscribedAtstring- null olabilirBiçim
date-time unsubscribedWithstring- null olabilirŞunlardan biri
"one-click""email""link" futureobjectThe rule that keeps moving its new mail, when there is one.
null olabilirruleIdstringdestinationstring- Şunlardan biri
"archive""bin""label" labelIdstring- null olabilir
SubscriptionDomainobject
objectstring- Şunlardan biri
"subscription_domain" domainstringnamestringsampleEmailstringOne sender address on the domain.
sendersintegerunsubscribableintegerSenders that can be unsubscribed without a person opening a page.
unreadintegerrecentintegertotalintegersinceUnsubscribedintegerlastSeenAtstring- Biçim
date-time
SubscriptionDomainListobject
objectstring- Şunlardan biri
"list" totalintegercountsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionListobject
objectstring- Şunlardan biri
"list" dataSubscription[]totalintegerRows that match, across every page.
countsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionMoveResultobject
objectstring- Şunlardan biri
"subscription_move" subscriptionIdstringmovedintegerConversations moved.
ruleIdstringThe rule that keeps moving new mail.
null olabilir
UnsubscribeResultobject
objectstring- Şunlardan biri
"unsubscribe" subscriptionIdstringthreadIdstringPresent when it was asked for through a thread.
methodstring- Şunlardan biri
"one-click""email""link" urlstringThe page to open when
methodislink, since that one needs a person.null olabilirbinnedintegerConversations moved to the Bin.