mailboxes.getRouting
List what delivers to a mailbox.
Returns the addresses that deliver mail to this mailbox, and whether it may send as each: its primary address, its other routes and their alias-domain spellings, the wildcard patterns aimed at it (catch_all for a bare *), and the groups it is a member of or the persona of. receives includes a group's persona archive as well as its members; canSend requires the domain to permit sending and, for a group, this mailbox to be its persona. An alias spelling receives only when both its alias and canonical domains receive, and its subaddressing follows the canonical domain. Unlike send-as, this keeps addresses that cannot send and patterns a From picker cannot offer. At most 200 eligible, distinct entries; truncated says when there were more. A domain-scoped key sees only its own domains.
openemail.mailboxes.getRouting(
mailboxId: string,
options?: CallOptions,
): ApiPromise<MailboxRouting>It calls GET /mailboxes/{mailboxId}/routing: List what delivers to a mailbox in the API reference.
Example
const mailboxRouting = await openemail.mailboxes.getRouting(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, MailboxRouting. 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: MailboxRouting.