Skip to Content

Restore a deleted mailbox.

Restores a soft-deleted mailbox from trash within its 7-day retention window. Re-binds the primary address if still available.

openemail.identities.restore(
  identityId: string,
  options?: CallOptions,
): ApiPromise<MailboxRestoreResult>

It calls POST /identities/{identityId}/restore: Restore a deleted mailbox in the API reference.

Example

const mailboxRestoreResult = await openemail.identities.restore(identityId)

Arguments

ArgumentTypeDescription
identityIdstringIdentity ULID identifier. The path's {identityId}.

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, MailboxRestoreResult. 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
404No restorable mailbox found
409not_deleted — mailbox is active or already restored
410gone — retention window elapsed or mailbox was permanently purged
503temporary_failure (with Retry-After): under the object directory, the account's identity census could not be updated just now, so the write that would move it was not made; retry the same request 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: MailboxRestoreResult.