SendUsage
The SendUsage type of the TypeScript SDK, which domains.getForwardUsage and mailboxes.getSendUsage take or answer.
type SendUsage = {
burstWindowSeconds: number
messages: number
messagesHour: number
msgsPerDay: number | null
msgsPerHour: number | null
rcptsPerDay: number | null
rcptsPerHour: number | null
recipients: number
recipientsHour: number
sendHold: ('disabled' | 'paused') | null
windowSeconds: number
}Fields
| Field | Type | Description |
|---|---|---|
burstWindowSeconds | number | Width of one burst bucket in seconds (3600); the burst figures cover two of them |
messages | number | Number of distinct messages sent in the rolling 24-hour window, plus each accepted list post whose fan-out is still being delivered: the count the daily limit is checked against |
messagesHour | number | Distinct messages in the BURST window — the current hourly bucket plus the previous one, so a burst stays visible for up to an hour after it ended |
msgsPerDay | number | null | Configured daily message limit (null = unlimited or unenforced) |
msgsPerHour | number | null | Configured hourly (burst) message limit (null = unlimited or unenforced) |
rcptsPerDay | number | null | Configured daily recipient limit (null = unlimited or unenforced) |
rcptsPerHour | number | null | Configured hourly (burst) recipient limit (null = unlimited or unenforced) |
recipients | number | Total recipient count sent to in the rolling 24-hour window, plus the recipients an accepted list post still holds for its fan-out: the count the daily limit is checked against |
recipientsHour | number | Recipients in the BURST window (current + previous hourly bucket) |
sendHold | ('disabled' | 'paused') | null | The mailbox's own hold: 'disabled' = permanent stop, 'paused' = reversible hold, null = neither |
windowSeconds | number | Duration of the rate-limit window in seconds (e.g. 86400 for 24h) |
Used by
| Method | What it does |
|---|---|
domains.getForwardUsage | Get domain forwarding rate limit usage |
mailboxes.getSendUsage | Get outbound send rate limit usage |