Remy Reference/Agent SDK/Email/UnsuppressResult

UnsuppressResult

Type

The result of `email.unsuppress`: whether the address was removed, and any platform-level suppression that still blocks delivery.

What email.unsuppress returns. When platformSuppression is non-null, the address is off your list but mail to it is still blocked platform-wide, so report that rather than success.

UnsuppressResult.ts

interface UnsuppressResult {
  ok: true
  removed: boolean
  platformSuppression: { reason: string; at: string | null } | null
}

Fields

true

The call succeeded.

removed

boolean

False when the address wasn't on your list to begin with.

platformSuppression

{ reason, at } | null

Non-null when the address is still blocked platform-wide (a hard bounce or complaint elsewhere).