Skip to Content

Forwarding disable link (confirmation page).

Public. Renders a confirmation page for the recipient of forwarded mail; the page's form (and RFC 8058 one-click) POSTs to the same URL. A GET never revokes anything — link scanners prefetch URLs. No bearer credential: the signed token in the path IS the credential, and its holder is a stranger receiving forwarded mail.

openemail.forwarding.getDisablePage(
  token: string,
  options?: CallOptions,
): ApiPromise<string>

It calls GET /forwarding/disable/{token}: Forwarding disable link (confirmation page) in the API reference. The operation is public: the client sends it without its credential.

Example

const text = await openemail.forwarding.getDisablePage(token)

Arguments

ArgumentTypeDescription
tokenstringSigned disable-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
403Invalid, superseded, or unknown link (indistinguishable)
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.