Skip to Content

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

FieldTypeDescription
effectiveDaysnumber | nullThe window in force for this mailbox after resolution
idstringMailbox ULID
previewRetentionPreview | nullWhat the previewed window (?days=, else the effective one) would expunge; null when there is no window to preview
primaryAddressstring | nullPrimary address, or null
retentionDaysnumber | nullThe mailbox's OWN window (null = inherits the account default, if any)
source('own' | 'account' | 'none')Where the effective window came from

Used by

MethodWhat it does
accounts.listRetentionPreview retention across an account's mailboxes

Used in

AccountRetention.