Skip to Content

Delete a message.

Soft-deletes a message to trash or permanently purges it. Use label to detach from a single label.

openemail.messages.delete(
  mailboxId: string,
  messageId: string,
  options?: MessagesDeleteOptions,
): ApiPromise<MessageDeleteResult>

It calls DELETE /mailboxes/{mailboxId}/messages/{messageId}: Delete a message in the API reference.

Example

const messageDeleteResult = await openemail.messages.delete(mailboxId, messageId)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
messageIdstringMessage ULID identifier. The path's {messageId}.

Options

The last argument, options, a MessagesDeleteOptions, takes:

OptionTypeSent asDescription
labelstringquery labelRemove message from this specific label only
purgebooleanquery purgeSet to 'true' to permanently delete message immediately instead of moving to trash

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

Errors

StatusWhat it means
400validation_failed or label_purge_exclusive
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox, message, or label not found
409not_labeled — message does not have the specified label
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: MessageDeleteResult.