AccountRetentionRow
The AccountRetentionRow type of the TypeScript SDK, which accounts.listRetention take or answer.
type AccountRetentionRow = {
effectiveDays: number | null
id: string
preview: RetentionPreview | null
primaryAddress: string | null
retentionDays: number | null
source: ('own' | 'account' | 'none')
}Fields
| Field | Type | Description |
|---|---|---|
effectiveDays | number | null | The window in force for this mailbox after resolution |
id | string | Mailbox ULID |
preview | RetentionPreview | null | What the previewed window (?days=, else the effective one) would expunge; null when there is no window to preview |
primaryAddress | string | null | Primary address, or null |
retentionDays | number | null | The mailbox's OWN window (null = inherits the account default, if any) |
source | ('own' | 'account' | 'none') | Where the effective window came from |
Used by
| Method | What it does |
|---|---|
accounts.listRetention | Preview retention across an account's mailboxes |