--- title: "openemail.suppressions" description: "Every method in this namespace: its signature, its parameters, what it returns and an example." url: "https://openemail.uk/docs/sdk/reference/suppressions" area: "SDK" category: "Reference" --- # openemail.suppressions Every method in this namespace: its signature, its parameters, what it returns and an example. ## Methods The addresses this workspace will not send to: hard bounces, complaints and the ones you block by hand. ### `suppressions.list()` List one page of the suppression list ```ts list(options?: SuppressionListOptions): Promise> ``` Resolves one page of the addresses this workspace will not send to, newest first: every address that bounced hard, complained, or was added by hand. `listAll` collects every page and `iterate` walks them lazily. A send to a suppressed address is refused for that recipient before anything leaves, and a message whose recipients are all suppressed fails outright. The list belongs to the whole workspace, so a key limited to some addresses reads all of it, and a row names the recipient, never which of your addresses sent to it. `removable` says whether `remove` will take the address off. A hard bounce is permanent here, because the address could not take mail. A complaint or a manual entry can be removed. Scopes: `settings:read`. **Parameters** - `options.q` (`string`): Searches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly. - `options.reason` (`SuppressionReason`): Keeps one kind: `bounce`, `complaint` or `manual`. - `options.limit` (`number`): Page size, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): The `nextCursor` of the previous page. Leave it out for the first page. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client API key for this call only. **Returns** `Page` with `items`, `hasMore` and `nextCursor`. Each item has `id`, `email`, `reason`, `detail`, `removable` and `createdAt`. **Example** ```ts const page = await openemail.suppressions.list({ reason: 'complaint' }) console.log(page.items.map((row) => [row.email, row.createdAt])) ``` **Notes** - Needs `settings:read`, the scope the Blocked addresses screen in Settings is gated on. - The cursor is opaque and holds where the last row sat, so an address removed between pages never breaks the walk. A cursor this list did not hand out is a 400 `invalid_cursor`. Also available in: API [`GET /suppressions`](https://openemail.uk/docs/api/reference/suppressions#get-suppressions); CLI [`openemail suppressions list`](https://openemail.uk/docs/cli/reference/suppressions#suppressions-list). ### `suppressions.listAll()` Collect the whole suppression list into one array ```ts listAll(options?: SuppressionListOptions): Promise> ``` Walks every page of `list` and resolves with every suppressed address, newest first. One request per page, with the same filters on each. Scopes: `settings:read`. **Parameters** - `options.q` (`string`): Searches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly. - `options.reason` (`SuppressionReason`): Keeps one kind: `bounce`, `complaint` or `manual`. - `options.limit` (`number`): Page size for each request, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): Starts the walk after this cursor instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it. - `options.apiKey` (`string`): Overrides the client API key for every page of this walk. **Returns** `Array` holding every suppressed address. **Example** ```ts const all = await openemail.suppressions.listAll({ limit: 100 }) const blocked = new Set(all.map((row) => row.email)) ``` **Notes** - If any page fails the promise rejects and the rows already fetched are discarded. Also available in: API [`GET /suppressions`](https://openemail.uk/docs/api/reference/suppressions#get-suppressions). ### `suppressions.iterate()` Stream the suppression list one address at a time ```ts iterate(options?: SuppressionListOptions): AsyncGenerator ``` Returns an async generator that yields one suppressed address at a time, newest first, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests. Scopes: `settings:read`. **Parameters** - `options.q` (`string`): Searches the address, the reason and the detail. Words match loosely, and a close spelling is tried when nothing matches exactly. - `options.reason` (`SuppressionReason`): Keeps one kind: `bounce`, `complaint` or `manual`. - `options.limit` (`number`): Page size for each request, from 1 to 100. The server defaults to 25. - `options.cursor` (`string`): Starts the walk after this cursor instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and the walk with it. - `options.apiKey` (`string`): Overrides the client API key for every page of this walk. **Returns** `AsyncGenerator` yielding one suppressed address per step. **Example** ```ts for await (const row of openemail.suppressions.iterate({ q: 'example.com' })) { console.log(row.email, row.reason) } ``` **Notes** - The generator is lazy, so an abandoned loop costs only the pages you consumed. Also available in: API [`GET /suppressions`](https://openemail.uk/docs/api/reference/suppressions#get-suppressions). ### `suppressions.get()` Read one suppressed address by id ```ts get(id: string, options?: RequestScope): Promise ``` Resolves one row of the suppression list: the address, why it is there, the detail the bounce or complaint carried, whether it can be removed and when it was added. Scopes: `settings:read`. **Parameters** - `id` (`string`, required): The id from `list`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client API key for this call only. **Returns** `SuppressionResource` with `id`, `email`, `reason`, `detail`, `removable` and `createdAt`. **Example** ```ts const row = await openemail.suppressions.get('7b1e2c3d-4f5a-4b6c-8d7e-9f0a1b2c3d4e') console.log(row.email, row.removable) ``` **Notes** - An id that is not on this workspace is a 404 `resource_not_found`. Also available in: API [`GET /suppressions/{id}`](https://openemail.uk/docs/api/reference/suppressions#get-suppressions-id); CLI [`openemail suppressions get`](https://openemail.uk/docs/cli/reference/suppressions#suppressions-get). ### `suppressions.add()` Stop sending to an address ```ts add(body: SuppressionAdd, options?: RequestScope): Promise ``` Puts an address on the suppression list by hand, with `reason: 'manual'`, so no address in the workspace sends to it again until it is removed. It is the Block an address control on the Blocked addresses screen. Adding an address that is already there changes nothing: the server answers 200 with the row it already holds, whatever its reason, where a new entry answers 201. Either way you get the row back. A new entry fires `suppression.added` to the webhooks that asked for it. Scopes: `settings:write`. **Parameters** - `body.email` (`string`, required): The address to stop sending to. It is trimmed and lower cased. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client API key for this call only. **Returns** `SuppressionResource` for the address, new or already there. **Example** ```ts const row = await openemail.suppressions.add({ email: 'noreply@example.com' }) console.log(row.reason, row.createdAt) ``` **Notes** - Safe to repeat: a second add finds the first entry, so the SDK retries it after a network failure. - A key limited to particular addresses or domains is refused with 422 `capability_unsupported`, because the list stops mail from every address in the workspace. So is an app connected by anybody but the owner. Also available in: API [`POST /suppressions`](https://openemail.uk/docs/api/reference/suppressions#post-suppressions); CLI [`openemail suppressions add`](https://openemail.uk/docs/cli/reference/suppressions#suppressions-add). ### `suppressions.remove()` Allow mail to an address again ```ts remove(id: string, options?: RequestScope): Promise ``` Takes an address off the suppression list, so mail may go to it again. It is Allow again on the Blocked addresses screen, and it fires `suppression.removed`. Only a complaint or a manual entry can be removed. A hard bounce answers 409 `suppression_not_removable` and stays, because the address could not take mail: check it is spelled right and send to the corrected one instead. Scopes: `settings:write`. **Parameters** - `id` (`string`, required): The id from `list`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client API key for this call only. **Returns** `RemovedSuppressionResource`, `{ object: 'suppression', id, email, deleted: true }`. **Example** ```ts const page = await openemail.suppressions.list({ q: 'ada@example.com' }) const row = page.items.find((item) => item.removable) if (row) await openemail.suppressions.remove(row.id) ``` **Notes** - The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked. - A key limited to particular addresses or domains is refused with 422 `capability_unsupported`. Also available in: API [`DELETE /suppressions/{id}`](https://openemail.uk/docs/api/reference/suppressions#delete-suppressions-id); CLI [`openemail suppressions remove`](https://openemail.uk/docs/cli/reference/suppressions#suppressions-remove).