mailboxes.getSendState
Get whether a mailbox may send.
Returns canSend and, when it is false, sendHold: the answer /auth/verify gives a login typed as the mailbox's primary address, from the same function, for a mailbox credential and without the password. sendHold is the fold across the mailbox, its account and its domain ('unverified' = publish DNS, 'receive_only' = the domain sends through another provider, 'paused' = a reversible hold, 'disabled' = a stop), unlike /send-usage's sendHold, which is the mailbox's own switch. Advisory; the submission gate is the authority.
openemail.mailboxes.getSendState(
mailboxId: string,
options?: CallOptions,
): ApiPromise<SendState>It calls GET /mailboxes/{mailboxId}/send-state: Get whether a mailbox may send in the API reference.
Example
const sendState = await openemail.mailboxes.getSendState(mailboxId)Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
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, SendState. 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 | Mailbox 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
It names these types of the API, each on a page of its own: SendState.