Skip to Content

Verified recipient confirmation link (confirm).

Public. The confirmation page's Confirm button: makes the address a verified recipient of the account that asked, and retires every link mailed for it. Idempotent: a second POST finds it already confirmed. No bearer credential: the signed token in the path IS the credential.

openemail.verifiedRecipients.confirmByToken(
  token: string,
  options?: CallOptions,
): ApiPromise<string>

It calls POST /recipients/confirm/{token}: Verified recipient confirmation link (confirm) in the API reference. The operation is public: the client sends it without its credential.

Example

const text = await openemail.verifiedRecipients.confirmByToken(token)

Arguments

ArgumentTypeDescription
tokenstringSigned confirmation-link token. The path's {token}.

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

Errors

StatusWhat it means
403A page saying the link is not valid, has expired (links work for seven days), or no longer works (its address was removed, or a newer link replaced it); nothing was changed
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.