Skip to Content

The AccountReceiveUsage type of the TypeScript SDK, which accounts.getReceiveUsage take or answer.

type AccountReceiveUsage = {
  accountId: string
  bytes: number
  bytesPerDay: number | null
  mailboxShare: number
  messages: number
  msgsPerDay: number | null
  topMailboxes: AccountReceiveUsageTopMailboxesItem[]
  windowSeconds: number
}

Fields

FieldTypeDescription
accountIdstringAccount ULID
bytesnumberBytes stored in the window, from the staged message sizes
bytesPerDaynumber | nullReceive allowance in force on the bytes axis (null = unenforced)
mailboxSharenumberFraction of each allowance one mailbox may draw alone (RECV_MAILBOX_SHARE); 1 = no per-mailbox level
messagesnumberMessages STORED for this account's mailboxes in the rolling 24-hour window (only stored mail charges — refused, aborted and duplicate deliveries do not)
msgsPerDaynumber | nullReceive allowance in force on the message axis (null = unenforced)
topMailboxesAccountReceiveUsageTopMailboxesItem[]The window's heaviest receivers, most messages first — the list that answers 'which address is being bombed' without a per-mailbox fan-out
windowSecondsnumberDuration of the window in seconds (86400)

Used by

MethodWhat it does
accounts.getReceiveUsageGet account receive allowance usage

On this page