Skip to Content

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

FieldTypeDescription
accountIdstringAccount ULID
mailboxesAccountRetentionRow[]This page of the account's mailboxes
minDaysnumberThe platform floor
nextCursorstringOptional. Cursor for the next page, present only when one exists
retentionDaysnumber | nullThe account default window (null = none)
unreadablestring[]Mailbox ids on this page whose store could not be read; their rows are omitted rather than reported as zero

Used by

MethodWhat it does
accounts.listRetentionPreview retention across an account's mailboxes
accounts.setRetentionSet account default retention window
accounts.clearRetentionClear account default retention window

On this page