Skip to Content

Expunge deleted messages from a label.

Detaches messages marked with the deleted flag from this label. Messages left with no remaining labels move to Recently deleted and can be restored until permanent purge.

openemail.labels.expunge(
  mailboxId: string,
  label: string,
  options?: CallOptions,
): ApiPromise<ExpungeResult>

It calls POST /mailboxes/{mailboxId}/labels/{label}/expunge: Expunge deleted messages from a label in the API reference.

Example

const expungeResult = await openemail.labels.expunge(mailboxId, label)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
labelstringLabel or folder name (e.g. INBOX, Archive, custom). The path's {label}.

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, ExpungeResult. 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 or label not found
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: ExpungeResult.