suppressions.get
Get suppression status for an address.
Inspects the global list by default; account callers see global hard bounces only. With accountId, inspects an account complaint; account callers may select only their own account.
openemail.suppressions.get(
address: string,
options?: SuppressionsGetOptions,
): ApiPromise<Suppression>It calls GET /suppressions/{address}: Get suppression status for an address in the API reference.
Example
const suppression = await openemail.suppressions.get(address)Arguments
| Argument | Type | Description |
|---|---|---|
address | string | Recipient email address to check. The path's {address}. |
Options
The last argument, options, a SuppressionsGetOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
accountId | string | query accountId | Sending 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, Suppression. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
403 | insufficient_scope — mailbox credentials or a foreign account; system_credentials_required — the global listing requires system credentials |
404 | not_found — the address is not suppressed, or not visible to this caller |
503 | suppression_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: Suppression.