--- title: "openemail.subscriptions" description: "Every method in this namespace: its signature, its parameters, what it returns and an example." url: "https://openemail.uk/docs/sdk/reference/subscriptions" area: "SDK" category: "Reference" --- # openemail.subscriptions Every method in this namespace: its signature, its parameters, what it returns and an example. ## Methods The newsletters and mailing lists the mailbox receives: list them by sender or by domain, unsubscribe, and move what they send. ### `subscriptions.list()` List subscriptions ```ts list(options?: SubscriptionListOptions): Promise ``` Resolves the newsletters and mailing lists the mailbox receives, as the Subscriptions page of the app shows them: one row per sender and the address it writes to, found from the `List-Unsubscribe` header of the mail it sends. Each row says how much mail the sender sent, how much of it is unread and how much arrived in the last 30 days, how it lets you unsubscribe, and the rule that keeps moving its new mail when there is one. `status` is `active`, the default, or `unsubscribed`. `q` searches the sender, and `sort` is `recent`, `most`, `unread` or `name`. Paging is by `offset`: `total` counts every match and `hasMore` says whether another page follows. A key limited to particular addresses lists only the subscriptions delivered to them, and `address` narrows the list to one address. Scopes: `threads:read`. **Parameters** - `options.status` (`SubscriptionStatus`): `active` or `unsubscribed`. Defaults to `active`. - `options.q` (`string`): Searches the sender name and address. - `options.sort` (`SubscriptionSort`): `recent`, `most`, `unread` or `name`. Defaults to `recent`. - `options.limit` (`number`): Rows per page, 1 to 200, defaulting to 50. - `options.offset` (`number`): How many rows to skip. - `options.address` (`string`): Only the subscriptions delivered to this address. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `SubscriptionListResource`, `{ object: 'list', data, total, counts, hasMore }`, where `counts` holds how many are `active` and `unsubscribed`. **Example** ```ts const page = await openemail.subscriptions.list({ sort: 'most', limit: 20 }) for (const row of page.data) console.log(row.senderEmail, row.total, row.method) ``` **Notes** - Read only, so the SDK retries it after a network failure like any other read. Also available in: API [`GET /subscriptions`](https://openemail.uk/docs/api/reference/subscriptions#get-subscriptions); CLI [`openemail subscriptions list`](https://openemail.uk/docs/cli/reference/subscriptions#subscriptions-list). ### `subscriptions.listDomains()` List subscriptions by domain ```ts listDomains(options?: SubscriptionListOptions): Promise ``` Resolves the same subscriptions as `list`, one row per sender domain with the counts of its senders added up, so a company that writes from several addresses is one row. `unsubscribable` counts the senders on the domain that can be unsubscribed without a person opening a page, which is what `unsubscribeDomain` acts on. It takes the same filters as `list`. Scopes: `threads:read`. **Parameters** - `options.status` (`SubscriptionStatus`): `active` or `unsubscribed`. Defaults to `active`. - `options.q` (`string`): Searches the sender name and address. - `options.sort` (`SubscriptionSort`): `recent`, `most`, `unread` or `name`. Defaults to `recent`. - `options.limit` (`number`): Rows per page, 1 to 200, defaulting to 50. - `options.offset` (`number`): How many rows to skip. - `options.address` (`string`): Only the subscriptions delivered to this address. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `SubscriptionDomainListResource`, `{ object: 'list', data, total, counts, hasMore }`. **Example** ```ts const page = await openemail.subscriptions.listDomains({ sort: 'most' }) for (const row of page.data) console.log(row.domain, row.senders, row.unsubscribable) ``` **Notes** - Read only, so the SDK retries it after a network failure like any other read. Also available in: API [`GET /subscriptions/domains`](https://openemail.uk/docs/api/reference/subscriptions#get-subscriptions-domains); CLI [`openemail subscriptions list-domains`](https://openemail.uk/docs/cli/reference/subscriptions#subscriptions-list-domains). ### `subscriptions.unsubscribe()` Unsubscribe from a sender ```ts unsubscribe(id: string, body?: SubscriptionUnsubscribe, options?: RequestScope): Promise ``` Unsubscribes the way the sender asks for it: a one-click request to its unsubscribe address when it offers one, otherwise an unsubscribe email sent from the address the mail arrived at. A sender that only offers a page cannot be unsubscribed by a program, so `method` is `link` and `url` is the page a person has to open. `bin` also moves every conversation from the sender to the Bin. A sender that gives no way to unsubscribe is a 422 `unsubscribe_unsupported`, and one whose one-click request failed with no address to write to is a 502 `unsubscribe_refused`. A subscription delivered to an address the key does not reach is a 404. Scopes: `threads:write`. **Parameters** - `id` (`string`, required): The subscription, from `list`. - `body.bin` (`boolean`): Also move every conversation from the sender to the Bin. Defaults to false. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `UnsubscribeResultResource`, `{ object: 'unsubscribe', subscriptionId, method, url, binned }`. **Example** ```ts const result = await openemail.subscriptions.unsubscribe('sub_7d2c1f0a9b3e4c5d6e7f8a9b', { bin: true }) if (result.method === 'link') console.log('Open', result.url) ``` **Notes** - The SDK does not retry it, because a second call can send a second unsubscribe email. Also available in: API [`POST /subscriptions/{id}/unsubscribe`](https://openemail.uk/docs/api/reference/subscriptions#post-subscriptions-id-unsubscribe); CLI [`openemail subscriptions unsubscribe`](https://openemail.uk/docs/cli/reference/subscriptions#subscriptions-unsubscribe). ### `subscriptions.unsubscribeDomain()` Unsubscribe from a whole domain ```ts unsubscribeDomain(domain: string, body?: SubscriptionDomainUnsubscribe, options?: RequestScope): Promise ``` Unsubscribes from every sender on a domain that can be unsubscribed without a person opening a page, with a one-click request or an unsubscribe email, as the domain view of the Subscriptions page does. `unsubscribed` counts the senders it worked for, `skipped` the senders that only offer a page and `failed` the ones that did not accept it. `bin` also moves their conversations to the Bin, and `address` keeps it to the subscriptions delivered to one address. A key limited to particular addresses acts only on the subscriptions delivered to them. Scopes: `threads:write`. **Parameters** - `domain` (`string`, required): The sender domain, from `listDomains`. - `body.bin` (`boolean`): Also move the conversations to the Bin. Defaults to false. - `body.address` (`string`): Only the subscriptions delivered to this address. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DomainUnsubscribeResultResource`, `{ object: 'domain_unsubscribe', domain, unsubscribed, skipped, failed, binned }`. **Example** ```ts const result = await openemail.subscriptions.unsubscribeDomain('news.acme.com') console.log(`${result.unsubscribed} unsubscribed, ${result.skipped} need a person`) ``` **Notes** - The SDK does not retry it, because a second call can send unsubscribe emails again. Also available in: API [`POST /subscriptions/domains/{domain}/unsubscribe`](https://openemail.uk/docs/api/reference/subscriptions#post-subscriptions-domains-domain-unsubscribe); CLI [`openemail subscriptions unsubscribe-domain`](https://openemail.uk/docs/cli/reference/subscriptions#subscriptions-unsubscribe-domain). ### `subscriptions.move()` Move what a sender sent ```ts move(id: string, body: SubscriptionMove, options?: RequestScope): Promise ``` Moves every conversation from the sender to the archive, the Bin or a label, as the Subscriptions page does. `destination` is `archive`, `bin` or `label`, and `label` needs `labelId`, or the call is a 422 `label_not_found`. With `future`, the default, a rule keeps doing it to new mail from the sender to that address, which also needs `rules:write`. `ruleName` names that rule. `future: false` drops a rule made that way before, when the key holds `rules:write`. Scopes: `threads:write`. **Parameters** - `id` (`string`, required): The subscription, from `list`. - `body.destination` (`SubscriptionDestination`, required): `archive`, `bin` or `label`. - `body.labelId` (`string`): The label to file under, for `label`. - `body.future` (`boolean`): Keep doing it to new mail with a rule. Defaults to true. - `body.ruleName` (`string`): A name for that rule. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `SubscriptionMoveResultResource`, `{ object: 'subscription_move', subscriptionId, moved, ruleId }`. **Example** ```ts const result = await openemail.subscriptions.move('sub_7d2c1f0a9b3e4c5d6e7f8a9b', { destination: 'archive' }) console.log(result.moved, result.ruleId) ``` **Notes** - The SDK retries it after a network failure, which is safe because moving the same mail again changes nothing and the rule is updated rather than added twice. Also available in: API [`POST /subscriptions/{id}/move`](https://openemail.uk/docs/api/reference/subscriptions#post-subscriptions-id-move); CLI [`openemail subscriptions move`](https://openemail.uk/docs/cli/reference/subscriptions#subscriptions-move).