AccountReceiveUsage
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
| Field | Type | Description |
|---|---|---|
accountId | string | Account ULID |
bytes | number | Bytes stored in the window, from the staged message sizes |
bytesPerDay | number | null | Receive allowance in force on the bytes axis (null = unenforced) |
mailboxShare | number | Fraction of each allowance one mailbox may draw alone (RECV_MAILBOX_SHARE); 1 = no per-mailbox level |
messages | number | Messages STORED for this account's mailboxes in the rolling 24-hour window (only stored mail charges — refused, aborted and duplicate deliveries do not) |
msgsPerDay | number | null | Receive allowance in force on the message axis (null = unenforced) |
topMailboxes | AccountReceiveUsageTopMailboxesItem[] | The window's heaviest receivers, most messages first — the list that answers 'which address is being bombed' without a per-mailbox fan-out |
windowSeconds | number | Duration of the window in seconds (86400) |
Used by
| Method | What it does |
|---|---|
accounts.getReceiveUsage | Get account receive allowance usage |
AccountLimitsLimits
Every plan limit, keyed by its field name on GET and PATCH /accounts/:accountId, which describe what each bounds. Each NULL value follows its platform default…
AccountReceiveUsageTopMailboxesItem
The AccountReceiveUsageTopMailboxesItem type of the TypeScript SDK, part of AccountReceiveUsage.