Skip to Content

Confirm the mailbox's pending recovery address.

Spends the mailed confirmation code and promotes the pending address to verified. A newly verified address that REPLACES one may receive notices but cannot drive a reset for 72 hours; the first address on a mailbox is usable at once.

openemail.recovery.confirmAddress(
  identityId: string,
  body: RecoveryConfirmAddressBody,
  options?: CallOptions,
): ApiPromise<RecoveryAddressVerified>

It calls POST /identities/{identityId}/recovery/confirm: Confirm the mailbox's pending recovery address in the API reference.

Example

const recoveryAddressVerified = await openemail.recovery.confirmAddress(identityId, { code: '…' })

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
bodyRecoveryConfirmAddressBodyThe 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, RecoveryAddressVerified. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed; or no_pending_address, meaning nothing is awaiting confirmation or it expired. One answer for both, so this cannot report whether an address is pending
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403invalid_code, with attemptsLeft; or confirmation_cleared, meaning that was the fifth wrong code and the pending address was dropped. Set it again
404Mailbox not found or not accessible to this principal
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
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

RecoveryConfirmAddressBody

/** The body of `recovery.confirmAddress`. */
type RecoveryConfirmAddressBody = {
  /** The 8-character code mailed to the pending address */
  code: string
}

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