Skip to Content

The AccountStorageUsage type of the TypeScript SDK, which accounts.getStorageUsage take or answer.

type AccountStorageUsage = {
  accountId: string
  complete: boolean
  computedAt: number | null
  limitBytes: number | null
  mailboxCount: number
  storageLimitBytes: number | null
  usedBytes: number | null
}

Fields

FieldTypeDescription
accountIdstringAccount ULID
completebooleanTrue when usedBytes is a full sum computed by this request. False for an account large enough that the walk is paged across passes: this request advanced the sweep by one pass and usedBytes is the last completed sweep's cached figure (null if none has finished yet). Poll until true.
computedAtnumber | nullTimestamp when usage was calculated in epoch seconds, or null when no sum has ever been computed for this account. When complete is false this is the cached gauge's stamp, not this request's.
limitBytesnumber | nullEffective storage limit in bytes (null = unlimited)
mailboxCountnumberTotal count of mailboxes owned by this account
storageLimitBytesnumber | nullConfigured storage limit override in bytes (null = default, 0 = unlimited)
usedBytesnumber | nullTotal storage used across all mailboxes in bytes including trash. NULL when complete is false and no full sweep has ever finished for this account: the sum is deliberately withheld rather than reported short, because a partial total would under-report storage.

Used by

MethodWhat it does
accounts.getStorageUsageGet account storage pool usage

On this page