Skip to Content

Remove another user's access to this mailbox.

Takes away an identity's access to this mailbox. Access stops immediately — rights are re-read on every request, so a session that is already open loses the mailbox on its next operation rather than at some later expiry.

The read/unread marks that identity had made in this mailbox are their own, and are discarded with the grant. Nothing belonging to the mailbox owner is deleted.

openemail.mailboxShares.revoke(
  mailboxId: string,
  granteeIdentityId: string,
  options?: CallOptions,
): ApiPromise<DeletedResult>

It calls DELETE /mailboxes/{mailboxId}/shares/{granteeIdentityId}: Remove another user's access to this mailbox in the API reference.

Example

const deletedResult = await openemail.mailboxShares.revoke(mailboxId, granteeIdentityId)

Arguments

ArgumentTypeDescription
mailboxIdstringULID of the mailbox whose access is being managed. The path's {mailboxId}.
granteeIdentityIdstringULID of the identity being given (or losing) access. The path's {granteeIdentityId}.

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, DeletedResult. 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, or that identity had no grant on it
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

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