Skip to Content

The MailboxWithStats type of the TypeScript SDK, which mailboxes.get take or answer.

type MailboxWithStats = Mailbox & {
  databaseLimitBytes?: number
  databaseSize?: number
  expungedBytes?: number
  expungedCount?: number
  liveSockets?: number
  messageCount?: number
  semanticFloor?: number | null
  socketCapacity?: number
  socketsByClass?: Record<string, number>
  usedBytes?: number
}

Fields

FieldTypeDescription
databaseLimitBytesnumberOptional. Ceiling limit for metadata database size in bytes
databaseSizenumberOptional. SQLite metadata database size in bytes
expungedBytesnumberOptional. Storage recoverable by emptying trash in bytes
expungedCountnumberOptional. Number of soft-deleted messages in trash
liveSocketsnumberOptional. Currently connected live-events WebSocket connections
messageCountnumberOptional. Total number of active messages
semanticFloornumber | nullOptional. When semantic search is on: the earliest arrival time (epoch seconds) the backfill embeds — mail received before it is lexically searchable only. 0 = everything. Lower it with PATCH /identities/:id { semanticFloor } ("index older mail"); null when semantic search is off
socketCapacitynumberOptional. Maximum allowed simultaneous WebSocket connections
socketsByClassRecord<string, number>Optional. Active WebSocket connections broken down by client class
usedBytesnumberOptional. Total storage used in bytes including trash

Used by

MethodWhat it does
mailboxes.getGet mailbox details and usage statistics

On this page