Skip to Content

Remove email address from suppression list.

Lifts a global suppression by default; account callers may lift global hard bounces only. With accountId, lifts that account's complaint, which requires system credentials: an account may inspect its own complaints but not lift them.

openemail.suppressions.remove(
  address: string,
  options?: SuppressionsRemoveOptions,
): ApiPromise<DeletedResult>

It calls DELETE /suppressions/{address}: Remove email address from suppression list in the API reference.

Example

const deletedResult = await openemail.suppressions.remove(address)

Arguments

ArgumentTypeDescription
addressstringRecipient email address to lift from suppression. The path's {address}.

Options

The last argument, options, a SuppressionsRemoveOptions, takes:

OptionTypeSent asDescription
accountIdstringquery accountIdSending account whose complaint suppressions to inspect or modify

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, DeletedResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403insufficient_scope — mailbox credentials; system_credentials_required — lifting an account complaint requires system credentials
404not_found — the address was not suppressed or is not liftable by this caller
503suppression_moving: the address's bucket is being moved; retry after the Retry-After delay. Or temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

It names these types of the API, each on a page of its own: DeletedResult.