sieve.activate
Activate a Sieve filter script.
Designates a specific script as the active filter for incoming mail delivery in this mailbox.
openemail.sieve.activate(
mailboxId: string,
body: SieveActivateBody,
options?: CallOptions,
): ApiPromise<SieveActivated>It calls PUT /mailboxes/{mailboxId}/sieve/active: Activate a Sieve filter script in the API reference.
Example
const result = await openemail.sieve.activate(mailboxId, { name: 'Ada' })Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
body | SieveActivateBody | The 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, SieveActivated. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | validation_failed — malformed script name |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | No such script, or mailbox not accessible |
409 | mailbox_is_group_persona — a group persona's archive runs no script |
413 | too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing |
503 | temporary_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
SieveActivateBody
/** The body of `sieve.activate`. */
type SieveActivateBody = {
/** Name of the script to activate */
name: string
}It names these types of the API, each on a page of its own: SieveActivated.