Interface: SuppressionsResource

Defined in: packages/sdk/src/resources/suppressions.ts:14

The project's do-not-send list. Bounces and complaints land here automatically; this resource is for manual entries and removals.

Example

await mailroom.suppressions.add("bad-address@example.com", "manual");
const list = await mailroom.suppressions.list();
await mailroom.suppressions.remove("bad-address@example.com");

Methods

add()

add(
   email: string, 
   reason?: SuppressionReason, 
   opts?: CallOptions): Promise<{
  email: string;
  reason: SuppressionReason;
}>;

Defined in: packages/sdk/src/resources/suppressions.ts:19

Suppress an address. Defaults to reason manual.

Parameters

Parameter	Type
email	string
reason?	SuppressionReason
opts?	CallOptions

Returns

Promise<{ email: string; reason: SuppressionReason; }>

---

list()

list(opts?: CallOptions): Promise<Suppression[]>;

Defined in: packages/sdk/src/resources/suppressions.ts:16

Every suppressed address for the project with its reason.

Parameters

Parameter	Type
opts?	CallOptions

Returns

Promise<Suppression[]>

---

remove()

remove(email: string, opts?: CallOptions): Promise<{
  deleted: boolean;
  email: string;
}>;

Defined in: packages/sdk/src/resources/suppressions.ts:26

Un-suppress an address, making it sendable again.

Parameters

Parameter	Type
email	string
opts?	CallOptions

Returns

Promise<{ deleted: boolean; email: string; }>