Abonnements
Chaque opération de ce groupe : ce qu'elle accepte, ce qu'elle retourne et les erreurs qu'elle peut renvoyer.
Opérations
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.
Paramètres de requête
statusstringactivelists what still arrives,unsubscribedwhat you left.L'un de"active""unsubscribed"Par défaut"active"qstringSearches the sender name and address.
Jusqu'à 200 caractèressortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.L'un de"recent""most""unread""name"Par défaut"recent"limitintegerRows per page.
Au moins 1Au plus 200Par défaut50offsetintegerHow many rows to skip, for the next page.
Au moins 0Par défaut0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
De 3 à 320 caractères
Retourne
A page of subscriptions.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de requête
statusstringactivelists what still arrives,unsubscribedwhat you left.L'un de"active""unsubscribed"Par défaut"active"qstringSearches the sender name and address.
Jusqu'à 200 caractèressortstringrecentputs the newest mail first,mostthe senders with the most mail,unreadthose with the most unread,namesorts by sender.L'un de"recent""most""unread""name"Par défaut"recent"limitintegerRows per page.
Au moins 1Au plus 200Par défaut50offsetintegerHow many rows to skip, for the next page.
Au moins 0Par défaut0addressstringOnly the subscriptions delivered to this address. One the key does not reach lists nothing.
De 3 à 320 caractères
Retourne
A page of sender domains.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
domainstringObligatoireThe sender domain, as
GET /subscriptions/domainsreturns it.
Corps de la requête
binbooleanAlso move every conversation from the senders to the Bin.
Par défautfalseaddressstringOnly the subscriptions delivered to this address.
De 3 à 320 caractères
Retourne
What happened to each sender, counted.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
idstringObligatoireThe subscription, as
GET /subscriptionsreturns it.
Corps de la requête
binbooleanAlso move every conversation from the sender to the Bin.
Par défautfalse
Retourne
How it was unsubscribed.
Erreurs
- 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.
Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
idstringObligatoireThe subscription, as
GET /subscriptionsreturns it.
Corps de la requête
destinationstringObligatoirearchive,binorlabel.L'un de"archive""bin""label"labelIdstringThe label to file under when
destinationislabel.Peut être nullDe 1 à 200 caractèresfuturebooleanAlso keep doing it to new mail from the sender, with a rule. Needs
rules:write.Par défauttrueruleNamestringA name for that rule.
Peut être nullJusqu'à 100 caractères
Retourne
How many conversations moved, and the rule.
Erreurs
Les erreurs que toute opération peut renvoyer400401403404422500Catalogue des erreurs
Aussi disponible dans
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.
Paramètres de chemin
idstringObligatoireThe thread, as
GET /threadsreturns it.
Retourne
How it was unsubscribed.
Erreurs
- 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.
Les erreurs que toute opération peut renvoyer400401403404500Catalogue des erreurs
Aussi disponible dans
Objets
DomainUnsubscribeResultobject
objectstring- L'un de
"domain_unsubscribe" domainstringunsubscribedintegerskippedintegerSenders that only offer a page.
failedintegerbinnedinteger
Subscriptionobject
objectstring- L'un de
"subscription" idstringsenderEmailstringsenderNamestring- Peut être null
recipientstringThe address the mail arrives at.
statusstring- L'un de
"active""unsubscribed" methodstringHow the sender lets you unsubscribe, or null when it gives no way.
Peut être nullL'un de"one-click""email""link"linkUrlstringIts unsubscribe page, when it has one.
Peut être nullunreadintegerrecentintegerMail in the last 30 days.
totalintegersinceUnsubscribedintegerMail that still arrived after you unsubscribed.
lastSeenAtstring- Format
date-time unsubscribedAtstring- Peut être nullFormat
date-time unsubscribedWithstring- Peut être nullL'un de
"one-click""email""link" futureobjectThe rule that keeps moving its new mail, when there is one.
Peut être nullruleIdstringdestinationstring- L'un de
"archive""bin""label" labelIdstring- Peut être null
SubscriptionDomainobject
objectstring- L'un de
"subscription_domain" domainstringnamestringsampleEmailstringOne sender address on the domain.
sendersintegerunsubscribableintegerSenders that can be unsubscribed without a person opening a page.
unreadintegerrecentintegertotalintegersinceUnsubscribedintegerlastSeenAtstring- Format
date-time
SubscriptionDomainListobject
objectstring- L'un de
"list" totalintegercountsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionListobject
objectstring- L'un de
"list" dataSubscription[]totalintegerRows that match, across every page.
countsobjectactiveintegerunsubscribedinteger
hasMoreboolean
SubscriptionMoveResultobject
objectstring- L'un de
"subscription_move" subscriptionIdstringmovedintegerConversations moved.
ruleIdstringThe rule that keeps moving new mail.
Peut être null
UnsubscribeResultobject
objectstring- L'un de
"unsubscribe" subscriptionIdstringthreadIdstringPresent when it was asked for through a thread.
methodstring- L'un de
"one-click""email""link" urlstringThe page to open when
methodislink, since that one needs a person.Peut être nullbinnedintegerConversations moved to the Bin.