Suscripciones
Cada operación de este grupo: lo que acepta, lo que devuelve y los errores con los que puede responder.
Operaciones
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.Uno de"active""unsubscribed"Predeterminado"active"qstringSearches the sender name and address.
Hasta 200 caracteressortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.Uno de"recent""most""unread""name"Predeterminado"recent"limitintegerRows per page.
Al menos 1Como máximo 200Predeterminado50offsetintegerHow many rows to skip, for the next page.
Al menos 0Predeterminado0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
De 3 a 320 caracteres
Devuelve
A page of subscriptions.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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.Uno de"active""unsubscribed"Predeterminado"active"qstringSearches the sender name and address.
Hasta 200 caracteressortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.Uno de"recent""most""unread""name"Predeterminado"recent"limitintegerRows per page.
Al menos 1Como máximo 200Predeterminado50offsetintegerHow many rows to skip, for the next page.
Al menos 0Predeterminado0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
De 3 a 320 caracteres
Devuelve
A page of sender domains.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
domainstringObligatorioThe sender domain, as
GET /subscriptions/domainsreturns it.
Cuerpo de la petición
binbooleanAlso move every conversation from the senders to the Bin.
PredeterminadofalseaddressstringOnly the subscriptions delivered to this address.
De 3 a 320 caracteres
Devuelve
What happened to each sender, counted.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe subscription, as
GET /subscriptionsreturns it.
Cuerpo de la petición
binbooleanAlso move every conversation from the sender to the Bin.
Predeterminadofalse
Devuelve
How it was unsubscribed.
Errores
- 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.
Los errores que puede devolver cualquier operación400401403404500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe subscription, as
GET /subscriptionsreturns it.
Cuerpo de la petición
destinationstringObligatorioarchive,binorlabel.Uno de"archive""bin""label"labelIdstringThe label to file under when
destinationislabel.Puede ser nullDe 1 a 200 caracteresfuturebooleanAlso keep doing it to new mail from the sender, with a rule. Needs
rules:write.PredeterminadotrueruleNamestringA name for that rule.
Puede ser nullHasta 100 caracteres
Devuelve
How many conversations moved, and the rule.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe thread, as
GET /threadsreturns it.
Devuelve
How it was unsubscribed.
Errores
- 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.
Los errores que puede devolver cualquier operación400401403404500Catálogo de errores
También disponible en
Objetos
DomainUnsubscribeResultobject
objectstring- Uno de
"domain_unsubscribe" domainstringunsubscribedintegerskippedintegerSenders that only offer a page.
failedintegerbinnedinteger
Subscriptionobject
objectstring- Uno de
"subscription" idstringsenderEmailstringsenderNamestring- Puede ser null
recipientstringThe address the mail arrives at.
statusstring- Uno de
"active""unsubscribed" methodstringHow the sender lets you unsubscribe, or null when it gives no way.
Puede ser nullUno de"one-click""email""link"linkUrlstringIts unsubscribe page, when it has one.
Puede ser nullunreadintegerrecentintegerMail in the last 30 days.
totalintegersinceUnsubscribedintegerMail that still arrived after you unsubscribed.
lastSeenAtstring- Formato
date-time unsubscribedAtstring- Puede ser nullFormato
date-time unsubscribedWithstring- Puede ser nullUno de
"one-click""email""link" futureobjectThe rule that keeps moving its new mail, when there is one.
Puede ser nullruleIdstringdestinationstring- Uno de
"archive""bin""label" labelIdstring- Puede ser null
SubscriptionDomainobject
objectstring- Uno 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- Uno de
"list" totalintegercountsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionListobject
objectstring- Uno de
"list" dataSubscription[]totalintegerRows that match, across every page.
countsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionMoveResultobject
objectstring- Uno de
"subscription_move" subscriptionIdstringmovedintegerConversations moved.
ruleIdstringThe rule that keeps moving new mail.
Puede ser null
UnsubscribeResultobject
objectstring- Uno de
"unsubscribe" subscriptionIdstringthreadIdstringPresent when it was asked for through a thread.
methodstring- Uno de
"one-click""email""link" urlstringThe page to open when
methodislink, since that one needs a person.Puede ser nullbinnedintegerConversations moved to the Bin.