Skip to Content

Issue mailbox recovery codes.

Issues a fresh set of ten single-use recovery codes and returns the plaintext exactly once, invalidating any previous set. Requires the current password.

openemail.recovery.createCodes(
  identityId: string,
  body: RecoveryCreateCodesBody,
  options?: CallOptions,
): ApiPromise<RecoveryCodesIssued>

It calls POST /identities/{identityId}/recovery/codes: Issue mailbox recovery codes in the API reference.

Example

const recoveryCodesIssued = await openemail.recovery.createCodes(identityId, { currentPassword: '…' })

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
bodyRecoveryCreateCodesBodyThe request's body.

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

Errors

StatusWhat it means
400validation_failed or password_required
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403invalid_password: the current password did not match. Or recovery_disabled: the account's policy is admin_only
404Mailbox not found or not accessible to this principal
409no_password_credential: the mailbox has no password to re-prove, so it cannot pass the sudo gate
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
429rate_limited: too many password re-proofs for this mailbox (every guess spends budget, right or wrong)
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

RecoveryCreateCodesBody

/** The body of `recovery.createCodes`. */
type RecoveryCreateCodesBody = {
  /** The mailbox's current password, re-proved */
  currentPassword: string
}

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