Skip to Content

Get Sieve filter script source.

Returns the raw Sieve source code and active status for a specific script.

openemail.sieve.getScript(
  mailboxId: string,
  scriptName: string,
  options?: CallOptions,
): ApiPromise<SieveScriptBody>

It calls GET /mailboxes/{mailboxId}/sieve/scripts/{scriptName}: Get Sieve filter script source in the API reference.

Example

const sieveScriptBody = await openemail.sieve.getScript(mailboxId, scriptName)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
scriptNamestringSieve script name. The path's {scriptName}.

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

Errors

StatusWhat it means
400validation_failed — malformed script name
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404No such script, or mailbox not accessible
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

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