Skip to Content

Get mailbox details and usage statistics.

Returns mailbox metadata, current storage usage, message counts, trash metrics, database size, and realtime socket connection stats.

openemail.mailboxes.get(
  mailboxId: string,
  options?: CallOptions,
): ApiPromise<MailboxWithStats>

It calls GET /mailboxes/{mailboxId}: Get mailbox details and usage statistics in the API reference.

Example

const mailboxWithStats = await openemail.mailboxes.get(mailboxId)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox 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, MailboxWithStats. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox not found or not accessible to this principal
503temporary_failure: the mail store could not report its usage just now (a storage fault, or no answer within a few seconds); retry after the Retry-After window

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: MailboxWithStats.