domains.getForwardUsage
Get domain forwarding rate limit usage.
Returns outbound email forwarding rate limit consumption (for group expansions and redirects) over the rolling 24-hour window for a domain. For an SRS bounce-return domain the isolated bounce-return budget is reported separately as srsBounce.
openemail.domains.getForwardUsage(
domain: string,
options?: CallOptions,
): ApiPromise<DomainsGetForwardUsageResult>It calls GET /domains/{domain}/forward-usage: Get domain forwarding rate limit usage in the API reference.
Example
const result = await openemail.domains.getForwardUsage(domain)Arguments
| Argument | Type | Description |
|---|---|---|
domain | string | Domain name (e.g. 'example.com'). The path's {domain}. |
Options
It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, DomainsGetForwardUsageResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Domain not found or not accessible to this principal |
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
DomainsGetForwardUsageResult
/** What `domains.getForwardUsage` answers. */
type DomainsGetForwardUsageResult = SendUsage & {
/** The SRS bounce-return channel's own budget — present only when the domain carries the srs flag. Isolated from the forwarding budget above, because SRS-shaped mail is an unauthenticated trigger and must not be able to spend a tenant channel's allowance. */
srsBounce?: DomainsGetForwardUsageResultSrsBounce
}DomainsGetForwardUsageResultSrsBounce
/** The SRS bounce-return channel's own budget — present only when the domain carries the srs flag. Isolated from the forwarding budget above, because SRS-shaped mail is an unauthenticated trigger and must not be able to spend a tenant channel's allowance. */
type DomainsGetForwardUsageResultSrsBounce = {
/** Bounce-return relays spent in the rolling 24-hour window */
messages: number
/** Daily bounce-return limit (null = unenforced) */
msgsPerDay: number | null
}It names these types of the API, each on a page of its own: SendUsage.