# Forward Email Sieve Scripts API

**Canonical:** https://apis.io/apis/forward-email/forward-email-sieve-scripts-api/  
**Provider:** Forward Email — https://apis.io/providers/forward-email/  
**Base URL:** https://api.forwardemail.net  
**Documentation:** https://forwardemail.net/

Forward Email Sieve Scripts API is one of 16 APIs that [Forward Email](https://apis.io/providers/forward-email/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Sieve Scripts. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Sieve script management endpoints >[!NOTE] > Sieve is a powerful email filtering language defined in RFC 5228. Scripts are executed on incoming mail to automatically organize, filter, and respond to messages. >[!TIP] > Supported extensions include: fileinto, reject, ereject, vacation, vacation-seconds, imap4flags, envelope, body, relational, comparator-i;ascii-numeric, copy, date, index, editheader, enotify, regex, subaddress, ihave, duplicate, special-use, mailbox, environment, and variables. Scripts are validated before saving to ensure they are syntactically correct. >[!NOTE] > **Two authentication methods are supported:** > - **API Token Auth** (`/v1/domains/{domain_id}/aliases/{alias_id}/sieve`): Use your API key as the username with Basic Auth. Requires domain_id and alias_id in the URL path. > - **Alias Auth** (`/v1/sieve-scripts`): Use the alias email and generated password as Basic Auth credentials. No domain_id or alias_id needed in the URL. >[!TIP] > Script ID parameters accept either the MongoDB ObjectId or the script name, allowing flexible script identification.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/domains/{domain_id}/aliases/{alias_id}/sieve` | List Sieve Scripts |
| POST | `/v1/domains/{domain_id}/aliases/{alias_id}/sieve` | Create Sieve Script |
| GET | `/v1/domains/{domain_id}/aliases/{alias_id}/sieve/{script_id}` | Get Sieve Script |
| PUT | `/v1/domains/{domain_id}/aliases/{alias_id}/sieve/{script_id}` | Update Sieve Script |
| DELETE | `/v1/domains/{domain_id}/aliases/{alias_id}/sieve/{script_id}` | Delete Sieve Script |
| POST | `/v1/domains/{domain_id}/aliases/{alias_id}/sieve/{script_id}/activate` | Activate Sieve Script |
| GET | `/v1/sieve-scripts` | List Sieve Scripts (Alias Auth) |
| POST | `/v1/sieve-scripts` | Create Sieve Script (Alias Auth) |
| GET | `/v1/sieve-scripts/{script_id}` | Get Sieve Script (Alias Auth) |
| PUT | `/v1/sieve-scripts/{script_id}` | Update Sieve Script (Alias Auth) |
| DELETE | `/v1/sieve-scripts/{script_id}` | Delete Sieve Script (Alias Auth) |
| POST | `/v1/sieve-scripts/{script_id}/activate` | Activate Sieve Script (Alias Auth) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/forward-email/openapi/forward-email-sieve-scripts-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-domain-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-update-domain-input-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-message-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-smtp-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-alias-account-schema.json
- **JSONSchema** — https://artifacts.apis.io/forward-email/json-schema/forward-email-alias-input-schema.json

## Other Forward Email APIs (12)

- [Forward Email Account API](https://apis.io/apis/forward-email/forward-email-account-api/)
- [Forward Email Aliases API](https://apis.io/apis/forward-email/forward-email-aliases-api/)
- [Forward Email Calendar Events API](https://apis.io/apis/forward-email/forward-email-calendar-events-api/)
- [Forward Email Calendars API](https://apis.io/apis/forward-email/forward-email-calendars-api/)
- [Forward Email Contacts API](https://apis.io/apis/forward-email/forward-email-contacts-api/)
- [Forward Email Domains API](https://apis.io/apis/forward-email/forward-email-domains-api/)
- [Forward Email Emails API](https://apis.io/apis/forward-email/forward-email-emails-api/)
- [Forward Email Encrypt API](https://apis.io/apis/forward-email/forward-email-encrypt-api/)
- [Forward Email Folders API](https://apis.io/apis/forward-email/forward-email-folders-api/)
- [Forward Email Invites API](https://apis.io/apis/forward-email/forward-email-invites-api/)
- [Forward Email Logs API](https://apis.io/apis/forward-email/forward-email-logs-api/)
- [Forward Email Members API](https://apis.io/apis/forward-email/forward-email-members-api/)

## Tags

Sieve Scripts

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/forward-email/forward-email-sieve-scripts-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/forward-email/.