Skip to Content

List who has access to this mailbox.

Returns everyone this mailbox has been shared with, oldest grant first, each with the rights they hold. This is the owner's side of sharing; to list mailboxes shared WITH you, use GET /shared-mailboxes instead.

The full list is always returned — grants are bounded by the account's own membership, so there is no paging.

openemail.mailboxShares.list(
  mailboxId: string,
  options?: CallOptions,
): ApiPromise<MailboxSharesListResult>

It calls GET /mailboxes/{mailboxId}/shares: List who has access to this mailbox in the API reference.

Example

const result = await openemail.mailboxShares.list(mailboxId)

Arguments

ArgumentTypeDescription
mailboxIdstringULID of the mailbox whose access is being managed. 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, MailboxSharesListResult. 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
404not_found — the mailbox does not exist or is not yours to manage
503temporary_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

MailboxSharesListResult

/** What `mailboxShares.list` answers. */
type MailboxSharesListResult = {
  shares: MailShare[]
}

It names these types of the API, each on a page of its own: MailShare.