Skip to Content

Confirm a forwarding destination.

Spends the code mailed to the destination. Five wrong codes end the ceremony. Confirming invalidates every disable link previously mailed for it.

openemail.forwarding.confirmDestination(
  mailboxId: string,
  destId: string,
  body: ForwardingConfirmDestinationBody,
  options?: CallOptions,
): ApiPromise<ForwardingDestinationVerified>

It calls POST /mailboxes/{mailboxId}/forwarding/destinations/{destId}/verify: Confirm a forwarding destination in the API reference.

Example

const forwardingDestinationVerified = await openemail.forwarding.confirmDestination(mailboxId, destId, { code: '…' })

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
destIdstringForwarding destination ULID. The path's {destId}.
bodyForwardingConfirmDestinationBodyThe 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, ForwardingDestinationVerified. 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_code, meaning nothing is awaiting confirmation or the code expired
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. Add the address again for a fresh one
404Mailbox or destination 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

ForwardingConfirmDestinationBody

/** The body of `forwarding.confirmDestination`. */
type ForwardingConfirmDestinationBody = {
  /** The eight-character code mailed to the destination */
  code: string
}

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