Subscrições
Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.
Operações
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.
Parâmetros de consulta
statusstringactivelists what still arrives,unsubscribedwhat you left.Um de"active""unsubscribed"Predefinição"active"qstringSearches the sender name and address.
Até 200 caracteressortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.Um de"recent""most""unread""name"Predefinição"recent"limitintegerRows per page.
Pelo menos 1No máximo 200Predefinição50offsetintegerHow many rows to skip, for the next page.
Pelo menos 0Predefinição0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
De 3 a 320 caracteres
Devolve
A page of subscriptions.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de consulta
statusstringactivelists what still arrives,unsubscribedwhat you left.Um de"active""unsubscribed"Predefinição"active"qstringSearches the sender name and address.
Até 200 caracteressortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.Um de"recent""most""unread""name"Predefinição"recent"limitintegerRows per page.
Pelo menos 1No máximo 200Predefinição50offsetintegerHow many rows to skip, for the next page.
Pelo menos 0Predefinição0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
De 3 a 320 caracteres
Devolve
A page of sender domains.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
domainstringObrigatórioThe sender domain, as
GET /subscriptions/domainsreturns it.
Corpo do pedido
binbooleanAlso move every conversation from the senders to the Bin.
PredefiniçãofalseaddressstringOnly the subscriptions delivered to this address.
De 3 a 320 caracteres
Devolve
What happened to each sender, counted.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe subscription, as
GET /subscriptionsreturns it.
Corpo do pedido
binbooleanAlso move every conversation from the sender to the Bin.
Predefiniçãofalse
Devolve
How it was unsubscribed.
Erros
- 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.
Os erros que qualquer operação pode devolver400401403404500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe subscription, as
GET /subscriptionsreturns it.
Corpo do pedido
destinationstringObrigatórioarchive,binorlabel.Um de"archive""bin""label"labelIdstringThe label to file under when
destinationislabel.Pode ser nullDe 1 a 200 caracteresfuturebooleanAlso keep doing it to new mail from the sender, with a rule. Needs
rules:write.PredefiniçãotrueruleNamestringA name for that rule.
Pode ser nullAté 100 caracteres
Devolve
How many conversations moved, and the rule.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe thread, as
GET /threadsreturns it.
Devolve
How it was unsubscribed.
Erros
- 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.
Os erros que qualquer operação pode devolver400401403404500Catálogo de erros
Também disponível em
Objetos
DomainUnsubscribeResultobject
objectstring- Um de
"domain_unsubscribe" domainstringunsubscribedintegerskippedintegerSenders that only offer a page.
failedintegerbinnedinteger
Subscriptionobject
objectstring- Um de
"subscription" idstringsenderEmailstringsenderNamestring- Pode ser null
recipientstringThe address the mail arrives at.
statusstring- Um de
"active""unsubscribed" methodstringHow the sender lets you unsubscribe, or null when it gives no way.
Pode ser nullUm de"one-click""email""link"linkUrlstringIts unsubscribe page, when it has one.
Pode ser nullunreadintegerrecentintegerMail in the last 30 days.
totalintegersinceUnsubscribedintegerMail that still arrived after you unsubscribed.
lastSeenAtstring- Formato
date-time unsubscribedAtstring- Pode ser nullFormato
date-time unsubscribedWithstring- Pode ser nullUm de
"one-click""email""link" futureobjectThe rule that keeps moving its new mail, when there is one.
Pode ser nullruleIdstringdestinationstring- Um de
"archive""bin""label" labelIdstring- Pode ser null
SubscriptionDomainobject
objectstring- Um de
"subscription_domain" domainstringnamestringsampleEmailstringOne sender address on the domain.
sendersintegerunsubscribableintegerSenders that can be unsubscribed without a person opening a page.
unreadintegerrecentintegertotalintegersinceUnsubscribedintegerlastSeenAtstring- Formato
date-time
SubscriptionDomainListobject
objectstring- Um de
"list" totalintegercountsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionListobject
objectstring- Um de
"list" dataSubscription[]totalintegerRows that match, across every page.
countsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionMoveResultobject
objectstring- Um de
"subscription_move" subscriptionIdstringmovedintegerConversations moved.
ruleIdstringThe rule that keeps moving new mail.
Pode ser null
UnsubscribeResultobject
objectstring- Um de
"unsubscribe" subscriptionIdstringthreadIdstringPresent when it was asked for through a thread.
methodstring- Um de
"one-click""email""link" urlstringThe page to open when
methodislink, since that one needs a person.Pode ser nullbinnedintegerConversations moved to the Bin.