Skip to Content

The MailboxWithUsage type of the TypeScript SDK, which identities.list take or answer.

type MailboxWithUsage = Mailbox & {
  databaseSize?: number | null
  messageCount?: number | null
  pimBytes?: number | null
  trashBytes?: number | null
  usageAt?: number
  usageStale?: boolean
  usedBytes?: number
}

Fields

FieldTypeDescription
databaseSizenumber | nullOptional. Sampled size of the store's own metadata database in bytes — the axis the store_metadata_full ceiling guards (metadata + search index, not message bytes); null when the sample predates this measure
messageCountnumber | nullOptional. Total number of active messages
pimBytesnumber | nullOptional. Storage used by calendar and contact objects in bytes
trashBytesnumber | nullOptional. Storage used by messages in trash in bytes
usageAtnumberOptional. Timestamp when usage was sampled in epoch seconds
usageStalebooleanOptional. True if the sampled usage figures could not be refreshed recently
usedBytesnumberOptional. Total active message storage used in bytes

Used by

MethodWhat it does
identities.listList mailboxes

On this page