Suppression
The Suppression type of the TypeScript SDK, which suppressions.list and suppressions.get take or answer.
type Suppression = {
accountId?: string
address: string
detail: string | null
eventCount: number
firstEventAt: number
lastEventAt: number
reason: ('complaint' | 'hard_bounce')
sourceDeliveryId: string | null
}Fields
| Field | Type | Description |
|---|---|---|
accountId | string | Optional. Sending account whose complaint blocks this recipient; absent for a deployment-global block |
address | string | Normalized (lowercased) recipient email address |
detail | string | null | Diagnostic error message or feedback detail from the bounce or complaint report |
eventCount | number | Total number of bounce or complaint events recorded for this address |
firstEventAt | number | Timestamp of first suppression event in epoch seconds |
lastEventAt | number | Timestamp of most recent suppression event in epoch seconds |
reason | ('complaint' | 'hard_bounce') | Reason for suppression ('complaint' from FBL report, or 'hard_bounce' from MTA) |
sourceDeliveryId | string | null | Delivery ID that triggered this suppression, or null |
Used by
| Method | What it does |
|---|---|
suppressions.list | List email suppressions |
suppressions.get | Get suppression status for an address |