구독 · API - OpenEmail

API

이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.

작업

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:read읽기

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.

쿼리 매개변수

statusstring: active lists what still arrives, unsubscribed what you left.
다음 중 하나"active""unsubscribed"기본값"active"
qstring: Searches the sender name and address.
최대 200자
sortstring: recent puts the newest mail first, most the senders with the most mail, unread those with the most unread, name sorts by sender.
다음 중 하나"recent""most""unread""name"기본값"recent"
limitinteger: Rows per page.
1 이상200 이하기본값50
offsetinteger: How many rows to skip, for the next page.
0 이상기본값0
addressstring: Only the subscriptions delivered to this address. One the key does not reach lists nothing.
3~320자

반환값

200SubscriptionList

A page of subscriptions.

오류

모든 작업이 반환할 수 있는 오류400401403404422500오류 목록

다른 사용처

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

GET`/subscriptions/domains`

List subscriptions by domain

threads:read읽기

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.

쿼리 매개변수

statusstring: active lists what still arrives, unsubscribed what you left.
다음 중 하나"active""unsubscribed"기본값"active"
qstring: Searches the sender name and address.
최대 200자
sortstring: recent puts the newest mail first, most the senders with the most mail, unread those with the most unread, name sorts by sender.
다음 중 하나"recent""most""unread""name"기본값"recent"
limitinteger: Rows per page.
1 이상200 이하기본값50
offsetinteger: How many rows to skip, for the next page.
0 이상기본값0
addressstring: Only the subscriptions delivered to this address. One the key does not reach lists nothing.
3~320자

반환값

200SubscriptionDomainList

A page of sender domains.

오류

모든 작업이 반환할 수 있는 오류400401403404422500오류 목록

다른 사용처

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

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

Unsubscribe from a whole domain

threads:write메일 발송

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.

경로 매개변수

domainstring필수: The sender domain, as GET /subscriptions/domains returns it.

요청 본문

binboolean: Also move every conversation from the senders to the Bin.
기본값false
addressstring: Only the subscriptions delivered to this address.
3~320자

반환값

200DomainUnsubscribeResult

What happened to each sender, counted.

오류

모든 작업이 반환할 수 있는 오류400401403404422500오류 목록

다른 사용처

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

POST`/subscriptions/{id}/unsubscribe`

Unsubscribe from a sender

threads:write메일 발송

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.

경로 매개변수

idstring필수: The subscription, as GET /subscriptions returns it.

요청 본문

binboolean: Also move every conversation from the sender to the Bin.
기본값false

반환값

200UnsubscribeResult

How it was unsubscribed.

오류

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.

모든 작업이 반환할 수 있는 오류400401403404500오류 목록

다른 사용처

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

POST`/subscriptions/{id}/move`

Move what a sender sent

threads:write데이터 변경

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.

경로 매개변수

idstring필수: The subscription, as GET /subscriptions returns it.

요청 본문

destinationstring필수: archive, bin or label.
다음 중 하나"archive""bin""label"
labelIdstring: The label to file under when destination is label.
null 가능1~200자
futureboolean: Also keep doing it to new mail from the sender, with a rule. Needs rules:write.
기본값true
ruleNamestring: A name for that rule.
null 가능최대 100자

반환값

200SubscriptionMoveResult

How many conversations moved, and the rule.

오류

모든 작업이 반환할 수 있는 오류400401403404422500오류 목록

다른 사용처

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

POST`/threads/{id}/unsubscribe`

Unsubscribe from the sender of a thread

threads:write메일 발송

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.

경로 매개변수

idstring필수: The thread, as GET /threads returns it.

반환값

200UnsubscribeResult

How it was unsubscribed.

오류

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.

모든 작업이 반환할 수 있는 오류400401403404500오류 목록

다른 사용처

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

객체

`DomainUnsubscribeResult`object

objectstring: 다음 중 하나"domain_unsubscribe"
domainstring
unsubscribedinteger
skippedinteger: Senders that only offer a page.
failedinteger
binnedinteger

`Subscription`object

objectstring

다음 중 하나"subscription"

idstring

senderEmailstring

senderNamestring

null 가능

recipientstring

The address the mail arrives at.

statusstring

다음 중 하나"active""unsubscribed"

methodstring

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

null 가능다음 중 하나"one-click""email""link"

linkUrlstring

Its unsubscribe page, when it has one.

null 가능

unreadinteger

recentinteger

Mail in the last 30 days.

totalinteger

sinceUnsubscribedinteger

Mail that still arrived after you unsubscribed.

lastSeenAtstring

형식date-time

unsubscribedAtstring

null 가능형식date-time

unsubscribedWithstring

null 가능다음 중 하나"one-click""email""link"

futureobject

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

null 가능

ruleIdstring
destinationstring: 다음 중 하나"archive""bin""label"
labelIdstring: null 가능

`SubscriptionDomain`object

objectstring: 다음 중 하나"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: 형식date-time

`SubscriptionDomainList`object

objectstring

다음 중 하나"list"

dataSubscriptionDomain[]

totalinteger

countsobject

activeinteger
unsubscribedinteger

hasMoreboolean

`SubscriptionList`object

objectstring

다음 중 하나"list"

dataSubscription[]

totalinteger

Rows that match, across every page.

countsobject

activeinteger
unsubscribedinteger

hasMoreboolean

`SubscriptionMoveResult`object

objectstring: 다음 중 하나"subscription_move"
subscriptionIdstring
movedinteger: Conversations moved.
ruleIdstring: The rule that keeps moving new mail.
null 가능

`UnsubscribeResult`object

objectstring: 다음 중 하나"unsubscribe"
subscriptionIdstring
threadIdstring: Present when it was asked for through a thread.
methodstring: 다음 중 하나"one-click""email""link"
urlstring: The page to open when method is link, since that one needs a person.
null 가능
binnedinteger: Conversations moved to the Bin.

구독

작업

쿼리 매개변수

반환값

오류

다른 사용처

쿼리 매개변수

반환값

오류

다른 사용처

경로 매개변수

요청 본문

반환값

오류

다른 사용처

경로 매개변수

요청 본문

반환값

오류

다른 사용처

경로 매개변수

요청 본문

반환값

오류

다른 사용처

경로 매개변수

반환값

오류

다른 사용처

객체

DomainUnsubscribeResultobject

Subscriptionobject

SubscriptionDomainobject

SubscriptionDomainListobject

SubscriptionListobject

SubscriptionMoveResultobject

UnsubscribeResultobject

받은편지함을,내 방식대로.

`DomainUnsubscribeResult`object

`Subscription`object

`SubscriptionDomain`object

`SubscriptionDomainList`object

`SubscriptionList`object

`SubscriptionMoveResult`object

`UnsubscribeResult`object

받은편지함을,
내 방식대로.