Skip to Content

Pause or resume forwarding.

Pauses or resumes forward-everything without touching the destination: a paused forward keeps its proof, so resuming never re-verifies.

openemail.forwarding.setPaused(
  mailboxId: string,
  body: ForwardingSetPausedBody,
  options?: CallOptions,
): ApiPromise<Forwarding>

It calls PATCH /mailboxes/{mailboxId}/forwarding/all: Pause or resume forwarding in the API reference.

Example

const forwarding = await openemail.forwarding.setPaused(mailboxId, { paused: true })

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
bodyForwardingSetPausedBodyThe 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, Forwarding. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox not found, or forwarding is not set
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

ForwardingSetPausedBody

/** The body of `forwarding.setPaused`. */
type ForwardingSetPausedBody = {
  /** True to pause forwarding, false to resume. Never re-verifies the destination */
  paused: boolean
}

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