---
title: "client.subscriptions"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://nextmail.sh/docs/ruby/reference/subscriptions"
area: "Ruby"
category: "Reference"
---

# client.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

```ruby
list(status: nil, q: nil, sort: nil, suggested: nil, limit: nil, offset: nil, address: nil, api_key: nil) -> Hash
```

Returns 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, `readPercent` (the share of it you read, 0 to 100) 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.

`suggested` marks an active sender worth leaving: it can be unsubscribed, sent at least 5 emails, wrote in the last 30 days and has 10% or less of its mail read. `suggested: true` lists only those.

`status:` is `active`, the default, `kept` for the ones you chose to keep with `keep`, or `unsubscribed`. `q:` searches the sender, and `sort:` is `recent`, `most`, `emails` (most mail overall), `read` (least read first), `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**

- `status` (`String`): `active`, `kept` or `unsubscribed`. Defaults to `active`.
- `q` (`String`): Searches the sender name and address.
- `sort` (`String`): `recent`, `most`, `emails`, `read`, `unread` or `name`. Defaults to `recent`.
- `suggested` (`Boolean`): Only the senders worth unsubscribing from, the rows whose `suggested` is true.
- `limit` (`Integer`): Rows per page, 1 to 200, defaulting to 50.
- `offset` (`Integer`): How many rows to skip.
- `address` (`String`): Only the subscriptions delivered to this address.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `list`, `data`, `total`, `counts` and `hasMore`, where `counts` holds how many are `active`, `kept` and `unsubscribed`.

**Example**

```ruby
page = client.subscriptions.list(sort: "emails", limit: 20)

page[:data].each { |row| puts "#{row[:senderEmail]} #{row[:total]} #{row[:readPercent]}% read #{row[:suggested]}" }
```

**Notes**

- Read only, so the SDK retries it after a network failure like any other read.

Also available in: API [`GET /subscriptions`](https://nextmail.sh/docs/api/reference/subscriptions#get-subscriptions); TypeScript [`nextmail.subscriptions.list()`](https://nextmail.sh/docs/sdk/reference/subscriptions#list); Python [`subscriptions.list()`](https://nextmail.sh/docs/python/reference/subscriptions#list); PHP [`subscriptions->list`](https://nextmail.sh/docs/php/reference/subscriptions#list); Go [`Subscriptions.List`](https://nextmail.sh/docs/go/reference/subscriptions#list); Java [`subscriptions().list`](https://nextmail.sh/docs/java/reference/subscriptions#list); C# [`Subscriptions.ListAsync`](https://nextmail.sh/docs/csharp/reference/subscriptions#list); CLI [`nextmail subscriptions list`](https://nextmail.sh/docs/cli/reference/subscriptions#subscriptions-list).

### `subscriptions.list_domains`

List subscriptions by domain

```ruby
list_domains(status: nil, q: nil, sort: nil, suggested: nil, limit: nil, offset: nil, address: nil, api_key: nil) -> Hash
```

Returns 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 `unsubscribe_domain` acts on, and `readPercent` is the share of the domain's mail you read.

It takes the same filters as `list`, and `suggested: true` lists the domains of the suggested senders.

Scopes: `threads:read`.

**Parameters**

- `status` (`String`): `active`, `kept` or `unsubscribed`. Defaults to `active`.
- `q` (`String`): Searches the sender name and address.
- `sort` (`String`): `recent`, `most`, `emails`, `read`, `unread` or `name`. Defaults to `recent`.
- `suggested` (`Boolean`): Only the senders worth unsubscribing from, the rows whose `suggested` is true.
- `limit` (`Integer`): Rows per page, 1 to 200, defaulting to 50.
- `offset` (`Integer`): How many rows to skip.
- `address` (`String`): Only the subscriptions delivered to this address.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `list`, `data`, `total`, `counts` and `hasMore`.

**Example**

```ruby
page = client.subscriptions.list_domains(sort: "most")

page[:data].each { |row| puts "#{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://nextmail.sh/docs/api/reference/subscriptions#get-subscriptions-domains); TypeScript [`nextmail.subscriptions.listDomains()`](https://nextmail.sh/docs/sdk/reference/subscriptions#listDomains); Python [`subscriptions.list_domains()`](https://nextmail.sh/docs/python/reference/subscriptions#listDomains); PHP [`subscriptions->listDomains`](https://nextmail.sh/docs/php/reference/subscriptions#listDomains); Go [`Subscriptions.ListDomains`](https://nextmail.sh/docs/go/reference/subscriptions#listDomains); Java [`subscriptions().listDomains`](https://nextmail.sh/docs/java/reference/subscriptions#listDomains); C# [`Subscriptions.ListDomainsAsync`](https://nextmail.sh/docs/csharp/reference/subscriptions#listDomains); CLI [`nextmail subscriptions list-domains`](https://nextmail.sh/docs/cli/reference/subscriptions#subscriptions-list-domains).

### `subscriptions.keep`

Keep subscriptions you want

```ruby
keep(ids, body = nil, api_key: nil, **fields) -> Hash
```

Marks active subscriptions as ones you want, as Keep on the Subscriptions page does: they move from `active` to `kept`, are never `suggested` again and are left alone by `unsubscribe_domain`. `kept: false` puts kept subscriptions back to `active`.

`updated` holds the subscriptions that changed. A subscription already in that state, or one you unsubscribed from, comes back in `skipped`, and an id that is unknown or delivered to an address the key does not reach in `missing`.

Scopes: `threads:write`.

**Parameters**

- `ids` (`Array<String>`, required): 1 to 100 subscription ids from `list`. A repeated id counts once.
- `kept` (`Boolean`): `true` keeps them, `false` puts them back to active. Defaults to true.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `subscription_batch_keep`, `kept`, `updated`, `skipped` and `missing`, each list holding subscription ids.

**Example**

```ruby
result = client.subscriptions.keep(["sub_7d2c1f0a9b3e4c5d6e7f8a9b"])

puts "#{result[:updated].size} kept"
```

**Notes**

- The SDK retries it after a network failure, which is safe because keeping a kept subscription changes nothing.

Also available in: API [`POST /subscriptions/batch-keep`](https://nextmail.sh/docs/api/reference/subscriptions#post-subscriptions-batch-keep); TypeScript [`nextmail.subscriptions.keep()`](https://nextmail.sh/docs/sdk/reference/subscriptions#keep); Python [`subscriptions.keep()`](https://nextmail.sh/docs/python/reference/subscriptions#keep); PHP [`subscriptions->keep`](https://nextmail.sh/docs/php/reference/subscriptions#keep); Go [`Subscriptions.Keep`](https://nextmail.sh/docs/go/reference/subscriptions#keep); Java [`subscriptions().keep`](https://nextmail.sh/docs/java/reference/subscriptions#keep); C# [`Subscriptions.KeepAsync`](https://nextmail.sh/docs/csharp/reference/subscriptions#keep); CLI [`nextmail subscriptions keep`](https://nextmail.sh/docs/cli/reference/subscriptions#subscriptions-keep).

### `subscriptions.unsubscribe`

Unsubscribe from a sender

```ruby
unsubscribe(id, body = nil, api_key: nil, **fields) -> Hash
```

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, and `archive:` archives them instead. `bin:` wins when both are true.

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`.
- `bin` (`Boolean`): Also move every conversation from the sender to the Bin. Defaults to false.
- `archive` (`Boolean`): Also archive every conversation from the sender. Defaults to false.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `unsubscribe`, `subscriptionId`, `method`, `url`, `binned` and `archived`.

**Example**

```ruby
result = client.subscriptions.unsubscribe("sub_7d2c1f0a9b3e4c5d6e7f8a9b", bin: true)

puts "Open #{result[:url]}" if result[:method] == "link"
```

**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://nextmail.sh/docs/api/reference/subscriptions#post-subscriptions-id-unsubscribe); TypeScript [`nextmail.subscriptions.unsubscribe()`](https://nextmail.sh/docs/sdk/reference/subscriptions#unsubscribe); Python [`subscriptions.unsubscribe()`](https://nextmail.sh/docs/python/reference/subscriptions#unsubscribe); PHP [`subscriptions->unsubscribe`](https://nextmail.sh/docs/php/reference/subscriptions#unsubscribe); Go [`Subscriptions.Unsubscribe`](https://nextmail.sh/docs/go/reference/subscriptions#unsubscribe); Java [`subscriptions().unsubscribe`](https://nextmail.sh/docs/java/reference/subscriptions#unsubscribe); C# [`Subscriptions.UnsubscribeAsync`](https://nextmail.sh/docs/csharp/reference/subscriptions#unsubscribe); CLI [`nextmail subscriptions unsubscribe`](https://nextmail.sh/docs/cli/reference/subscriptions#subscriptions-unsubscribe).

### `subscriptions.unsubscribe_many`

Unsubscribe from up to 100 senders in one call

```ruby
unsubscribe_many(ids, body = nil, api_key: nil, **fields) -> Hash
```

Unsubscribes from each subscription in `ids` the way `unsubscribe` does for one, as Unsubscribe on a selection of the Subscriptions page does, and reports the rest instead of failing. `unsubscribed` holds the ones done with a one-click request or an unsubscribe email.

A sender that only unsubscribes on its own page comes back in `links` with the `url` a person has to open, and stays active until somebody does. `skipped` holds the ones already unsubscribed (`already_unsubscribed`) or that give no way to unsubscribe (`no_method`), `failed` the ones whose sender did not accept it, and `missing` the ids that are unknown or delivered to an address the key does not reach.

`archive:` also archives every conversation from the senders that were unsubscribed, and `bin:` moves them to the Bin instead.

Scopes: `threads:write`.

**Parameters**

- `ids` (`Array<String>`, required): 1 to 100 subscription ids from `list`, for example the rows whose `suggested` is true. A repeated id counts once.
- `archive` (`Boolean`): Also archive every conversation from the senders. Defaults to false.
- `bin` (`Boolean`): Also move every conversation from the senders to the Bin. Defaults to false.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `subscription_batch_unsubscribe`, `unsubscribed`, `links`, `skipped`, `failed`, `missing`, `binned` and `archived`. Each entry of `links` is a Hash with `id` and `url`, and each entry of `skipped` a Hash with `id` and `reason`.

**Example**

```ruby
page = client.subscriptions.list(suggested: true)
result = client.subscriptions.unsubscribe_many(page[:data].map { |row| row[:id] }, archive: true)

puts "#{result[:unsubscribed].size} unsubscribed, #{result[:archived]} archived"

result[:links].each { |step| puts "Open #{step[:url]}" }
```

**Notes**

- A partial result returns normally rather than raising, so read `links`, `skipped`, `failed` and `missing` to see what stayed.
- The SDK does not retry it, because a second call can send unsubscribe emails again.

Also available in: API [`POST /subscriptions/batch-unsubscribe`](https://nextmail.sh/docs/api/reference/subscriptions#post-subscriptions-batch-unsubscribe); TypeScript [`nextmail.subscriptions.unsubscribeMany()`](https://nextmail.sh/docs/sdk/reference/subscriptions#unsubscribeMany); Python [`subscriptions.unsubscribe_many()`](https://nextmail.sh/docs/python/reference/subscriptions#unsubscribeMany); PHP [`subscriptions->unsubscribeMany`](https://nextmail.sh/docs/php/reference/subscriptions#unsubscribeMany); Go [`Subscriptions.UnsubscribeMany`](https://nextmail.sh/docs/go/reference/subscriptions#unsubscribeMany); Java [`subscriptions().unsubscribeMany`](https://nextmail.sh/docs/java/reference/subscriptions#unsubscribeMany); C# [`Subscriptions.UnsubscribeManyAsync`](https://nextmail.sh/docs/csharp/reference/subscriptions#unsubscribeMany); CLI [`nextmail subscriptions unsubscribe-many`](https://nextmail.sh/docs/cli/reference/subscriptions#subscriptions-unsubscribe-many).

### `subscriptions.unsubscribe_domain`

Unsubscribe from a whole domain

```ruby
unsubscribe_domain(domain, body = nil, api_key: nil, **fields) -> Hash
```

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.

Senders you kept with `keep` are left alone. `bin:` also moves their conversations to the Bin, `archive:` archives them instead, 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 `list_domains`.
- `bin` (`Boolean`): Also move the conversations to the Bin. Defaults to false.
- `archive` (`Boolean`): Also archive the conversations. Defaults to false.
- `address` (`String`): Only the subscriptions delivered to this address.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `domain_unsubscribe`, `domain`, `unsubscribed`, `skipped`, `failed`, `binned` and `archived`.

**Example**

```ruby
result = client.subscriptions.unsubscribe_domain("news.acme.com")

puts "#{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://nextmail.sh/docs/api/reference/subscriptions#post-subscriptions-domains-domain-unsubscribe); TypeScript [`nextmail.subscriptions.unsubscribeDomain()`](https://nextmail.sh/docs/sdk/reference/subscriptions#unsubscribeDomain); Python [`subscriptions.unsubscribe_domain()`](https://nextmail.sh/docs/python/reference/subscriptions#unsubscribeDomain); PHP [`subscriptions->unsubscribeDomain`](https://nextmail.sh/docs/php/reference/subscriptions#unsubscribeDomain); Go [`Subscriptions.UnsubscribeDomain`](https://nextmail.sh/docs/go/reference/subscriptions#unsubscribeDomain); Java [`subscriptions().unsubscribeDomain`](https://nextmail.sh/docs/java/reference/subscriptions#unsubscribeDomain); C# [`Subscriptions.UnsubscribeDomainAsync`](https://nextmail.sh/docs/csharp/reference/subscriptions#unsubscribeDomain); CLI [`nextmail subscriptions unsubscribe-domain`](https://nextmail.sh/docs/cli/reference/subscriptions#subscriptions-unsubscribe-domain).

### `subscriptions.move`

Move what a sender sent

```ruby
move(id, body = nil, api_key: nil, **fields) -> Hash
```

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`.
- `destination` (`String`, required): `archive`, `bin` or `label`.
- `labelId` (`String`): The label to file under, for `label`.
- `future` (`Boolean`): Keep doing it to new mail with a rule. Defaults to true.
- `ruleName` (`String`): A name for that rule.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `subscription_move`, `subscriptionId`, `moved` and `ruleId`.

**Example**

```ruby
result = client.subscriptions.move("sub_7d2c1f0a9b3e4c5d6e7f8a9b", destination: "archive")

puts 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://nextmail.sh/docs/api/reference/subscriptions#post-subscriptions-id-move); TypeScript [`nextmail.subscriptions.move()`](https://nextmail.sh/docs/sdk/reference/subscriptions#move); Python [`subscriptions.move()`](https://nextmail.sh/docs/python/reference/subscriptions#move); PHP [`subscriptions->move`](https://nextmail.sh/docs/php/reference/subscriptions#move); Go [`Subscriptions.Move`](https://nextmail.sh/docs/go/reference/subscriptions#move); Java [`subscriptions().move`](https://nextmail.sh/docs/java/reference/subscriptions#move); C# [`Subscriptions.MoveAsync`](https://nextmail.sh/docs/csharp/reference/subscriptions#move); CLI [`nextmail subscriptions move`](https://nextmail.sh/docs/cli/reference/subscriptions#subscriptions-move).

### `subscriptions.move_many`

Move what up to 100 senders sent

```ruby
move_many(ids, body = nil, api_key: nil, **fields) -> Hash
```

Moves every conversation from each subscription in `ids` to the archive, the Bin or a label, the way `move` does for one, as Archive on a selection of 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 per sender keeps doing it to new mail, which also needs `rules:write`. `moved` counts the conversations moved across every sender, `updated` holds the subscriptions whose mail moved, `failed` the ones that could not be moved and `missing` the ids that are unknown or delivered to an address the key does not reach.

Scopes: `threads:write`.

**Parameters**

- `ids` (`Array<String>`, required): 1 to 100 subscription ids from `list`. A repeated id counts once.
- `destination` (`String`, required): `archive`, `bin` or `label`.
- `labelId` (`String`): The label to file under, for `label`.
- `future` (`Boolean`): Keep doing it to new mail with a rule per sender. Defaults to true.
- `api_key` (`String`): Overrides the client's API key for this call only.

**Returns**

A Hash with `object` set to `subscription_batch_move`, `moved`, `updated`, `failed` and `missing`.

**Example**

```ruby
ids = ["sub_7d2c1f0a9b3e4c5d6e7f8a9b", "sub_0c3e2a91d4b7f6058e1a2b3c"]
result = client.subscriptions.move_many(ids, destination: "archive", future: false)

puts "#{result[:moved]} conversations archived"
```

**Notes**

- The SDK retries it after a network failure, which is safe because moving the same mail again changes nothing and each rule is updated rather than added twice.

Also available in: API [`POST /subscriptions/batch-move`](https://nextmail.sh/docs/api/reference/subscriptions#post-subscriptions-batch-move); TypeScript [`nextmail.subscriptions.moveMany()`](https://nextmail.sh/docs/sdk/reference/subscriptions#moveMany); Python [`subscriptions.move_many()`](https://nextmail.sh/docs/python/reference/subscriptions#moveMany); PHP [`subscriptions->moveMany`](https://nextmail.sh/docs/php/reference/subscriptions#moveMany); Go [`Subscriptions.MoveMany`](https://nextmail.sh/docs/go/reference/subscriptions#moveMany); Java [`subscriptions().moveMany`](https://nextmail.sh/docs/java/reference/subscriptions#moveMany); C# [`Subscriptions.MoveManyAsync`](https://nextmail.sh/docs/csharp/reference/subscriptions#moveMany); CLI [`nextmail subscriptions move-many`](https://nextmail.sh/docs/cli/reference/subscriptions#subscriptions-move-many).