AccountRetention
The AccountRetention type of the TypeScript SDK, which accounts.listRetention and 2 more methods take or answer.
type AccountRetention = {
accountId: string
mailboxes: AccountRetentionRow[]
minDays: number
nextCursor?: string
retentionDays: number | null
unreadable: string[]
}Fields
| Field | Type | Description |
|---|---|---|
accountId | string | Account ULID |
mailboxes | AccountRetentionRow[] | This page of the account's mailboxes |
minDays | number | The platform floor |
nextCursor | string | Optional. Cursor for the next page, present only when one exists |
retentionDays | number | null | The account default window (null = none) |
unreadable | string[] | Mailbox ids on this page whose store could not be read; their rows are omitted rather than reported as zero |
Used by
| Method | What it does |
|---|---|
accounts.listRetention | Preview retention across an account's mailboxes |
accounts.setRetention | Set account default retention window |
accounts.clearRetention | Clear account default retention window |