API

Abonimet

Çdo veprim në këtë grup: çfarë pranon, çfarë kthen dhe gabimet me të cilat mund të përgjigjet.

Veprimet

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

threads:readLexon

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.

Parametrat e pyetjes

statusstring: active lists what still arrives, unsubscribed what you left.
Një nga"active""unsubscribed"Parazgjedhja"active"
qstring: Searches the sender name and address.
Deri në 200 karaktere
sortstring: recent puts the newest mail first, most the senders with the most mail, unread those with the most unread, name sorts by sender.
Një nga"recent""most""unread""name"Parazgjedhja"recent"
limitinteger: Rows per page.
Të paktën 1Më së shumti 200Parazgjedhja50
offsetinteger: How many rows to skip, for the next page.
Të paktën 0Parazgjedhja0
addressstring: Only the subscriptions delivered to this address. One the key does not reach lists nothing.
Nga 3 deri në 320 karaktere

Kthen

200SubscriptionList

A page of subscriptions.

Gabimet

Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve

E disponueshme edhe në

SDK: subscriptions.list()
CLI: openemail subscriptions list
MCP: listSubscriptions

GET`/subscriptions/domains`

List subscriptions by domain

threads:readLexon

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.

Parametrat e pyetjes

statusstring: active lists what still arrives, unsubscribed what you left.
Një nga"active""unsubscribed"Parazgjedhja"active"
qstring: Searches the sender name and address.
Deri në 200 karaktere
sortstring: recent puts the newest mail first, most the senders with the most mail, unread those with the most unread, name sorts by sender.
Një nga"recent""most""unread""name"Parazgjedhja"recent"
limitinteger: Rows per page.
Të paktën 1Më së shumti 200Parazgjedhja50
offsetinteger: How many rows to skip, for the next page.
Të paktën 0Parazgjedhja0
addressstring: Only the subscriptions delivered to this address. One the key does not reach lists nothing.
Nga 3 deri në 320 karaktere

Kthen

200SubscriptionDomainList

A page of sender domains.

Gabimet

Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve

E disponueshme edhe në

SDK: subscriptions.listDomains()
CLI: openemail subscriptions list-domains
MCP: listSubscriptionDomains

POST`/subscriptions/domains/{domain}/unsubscribe`

Unsubscribe from a whole domain

threads:writeDërgon email

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.

Parametrat e shtegut

domainstringE detyrueshme: The sender domain, as GET /subscriptions/domains returns it.

Trupi i kërkesës

binboolean: Also move every conversation from the senders to the Bin.
Parazgjedhjafalse
addressstring: Only the subscriptions delivered to this address.
Nga 3 deri në 320 karaktere

Kthen

200DomainUnsubscribeResult

What happened to each sender, counted.

Gabimet

Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve

E disponueshme edhe në

SDK: subscriptions.unsubscribeDomain()
CLI: openemail subscriptions unsubscribe-domain
MCP: unsubscribeSubscriptionDomain

POST`/subscriptions/{id}/unsubscribe`

Unsubscribe from a sender

threads:writeDërgon email

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.

Parametrat e shtegut

idstringE detyrueshme: The subscription, as GET /subscriptions returns it.

Trupi i kërkesës

binboolean: Also move every conversation from the sender to the Bin.
Parazgjedhjafalse

Kthen

200UnsubscribeResult

How it was unsubscribed.

Gabimet

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.

Gabimet që mund të kthejë çdo veprim400401403404500Katalogu i gabimeve

E disponueshme edhe në

SDK: subscriptions.unsubscribe()
CLI: openemail subscriptions unsubscribe
MCP: unsubscribeSubscription

POST`/subscriptions/{id}/move`

Move what a sender sent

threads:writeNdryshon të dhëna

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.

Parametrat e shtegut

idstringE detyrueshme: The subscription, as GET /subscriptions returns it.

Trupi i kërkesës

destinationstringE detyrueshme: archive, bin or label.
Një nga"archive""bin""label"
labelIdstring: The label to file under when destination is label.
Mund të jetë nullNga 1 deri në 200 karaktere
futureboolean: Also keep doing it to new mail from the sender, with a rule. Needs rules:write.
Parazgjedhjatrue
ruleNamestring: A name for that rule.
Mund të jetë nullDeri në 100 karaktere

Kthen

200SubscriptionMoveResult

How many conversations moved, and the rule.

Gabimet

Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve

E disponueshme edhe në

SDK: subscriptions.move()
CLI: openemail subscriptions move
MCP: moveSubscription

POST`/threads/{id}/unsubscribe`

Unsubscribe from the sender of a thread

threads:writeDërgon email

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.

Parametrat e shtegut

idstringE detyrueshme: The thread, as GET /threads returns it.

Kthen

200UnsubscribeResult

How it was unsubscribed.

Gabimet

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.

Gabimet që mund të kthejë çdo veprim400401403404500Katalogu i gabimeve

E disponueshme edhe në

SDK: threads.unsubscribe()
CLI: openemail threads unsubscribe
MCP: unsubscribeThread

Objektet

`DomainUnsubscribeResult`object

objectstring: Një nga"domain_unsubscribe"
domainstring
unsubscribedinteger
skippedinteger: Senders that only offer a page.
failedinteger
binnedinteger

`Subscription`object

objectstring

Një nga"subscription"

idstring

senderEmailstring

senderNamestring

Mund të jetë null

recipientstring

The address the mail arrives at.

statusstring

Një nga"active""unsubscribed"

methodstring

How the sender lets you unsubscribe, or null when it gives no way.

Mund të jetë nullNjë nga"one-click""email""link"

linkUrlstring

Its unsubscribe page, when it has one.

Mund të jetë null

unreadinteger

recentinteger

Mail in the last 30 days.

totalinteger

sinceUnsubscribedinteger

Mail that still arrived after you unsubscribed.

lastSeenAtstring

Formatidate-time

unsubscribedAtstring

Mund të jetë nullFormatidate-time

unsubscribedWithstring

Mund të jetë nullNjë nga"one-click""email""link"

futureobject

The rule that keeps moving its new mail, when there is one.

Mund të jetë null

ruleIdstring
destinationstring: Një nga"archive""bin""label"
labelIdstring: Mund të jetë null

`SubscriptionDomain`object

objectstring: Një nga"subscription_domain"
domainstring
namestring
sampleEmailstring: One sender address on the domain.
sendersinteger
unsubscribableinteger: Senders that can be unsubscribed without a person opening a page.
unreadinteger
recentinteger
totalinteger
sinceUnsubscribedinteger
lastSeenAtstring: Formatidate-time

`SubscriptionDomainList`object

objectstring

Një nga"list"

dataSubscriptionDomain[]

totalinteger

countsobject

activeinteger
unsubscribedinteger

hasMoreboolean

`SubscriptionList`object

objectstring

Një nga"list"

dataSubscription[]

totalinteger

Rows that match, across every page.

countsobject

activeinteger
unsubscribedinteger

hasMoreboolean

`SubscriptionMoveResult`object

objectstring: Një nga"subscription_move"
subscriptionIdstring
movedinteger: Conversations moved.
ruleIdstring: The rule that keeps moving new mail.
Mund të jetë null

`UnsubscribeResult`object

objectstring: Një nga"unsubscribe"
subscriptionIdstring
threadIdstring: Present when it was asked for through a thread.
methodstring: Një nga"one-click""email""link"
urlstring: The page to open when method is link, since that one needs a person.
Mund të jetë null
binnedinteger: Conversations moved to the Bin.

Abonimet

Veprimet

Parametrat e pyetjes

Kthen

Gabimet

E disponueshme edhe në

Parametrat e pyetjes

Kthen

Gabimet

E disponueshme edhe në

Parametrat e shtegut

Trupi i kërkesës

Kthen

Gabimet

E disponueshme edhe në

Parametrat e shtegut

Trupi i kërkesës

Kthen

Gabimet

E disponueshme edhe në

Parametrat e shtegut

Trupi i kërkesës

Kthen

Gabimet

E disponueshme edhe në

Parametrat e shtegut

Kthen

Gabimet

E disponueshme edhe në

Objektet

DomainUnsubscribeResultobject

Subscriptionobject

SubscriptionDomainobject

SubscriptionDomainListobject

SubscriptionListobject

SubscriptionMoveResultobject

UnsubscribeResultobject

Kutia juaj hyrëse,sipas kushteve tuaja.

`DomainUnsubscribeResult`object

`Subscription`object

`SubscriptionDomain`object

`SubscriptionDomainList`object

`SubscriptionList`object

`SubscriptionMoveResult`object

`UnsubscribeResult`object

Kutia juaj hyrëse,
sipas kushteve tuaja.