Introduction

Avelsieve or, verbosely, "SIEVE Mail Filters Plugin for Squirrelmail" is a Squirrelmail plugin for creating SIEVE scripts on a Cyrus IMAP server that runs timsieved (Tim's SIEVE daemon).

Avelsieve will also be a part of Cyrusmaster, a web-based Cyrus administration tool. It should provide the same interface of the user's filters to administrators and/or helpdesk staff.

SIEVE is a mail filtering language, intended for server-side filtering of emails. See RFC 3028 and Cyrusoft's page about SIEVE for more details.

About this implementation

The web interface provides a wizard-like interface that, in the end, creates part of a SIEVE script, a so called rule. It then assembles all the rules to form a SIEVE script.

For the sake of user-friendliness, it provides only a subset of SIEVE's functionality; the main goal was to provide a simple interface for Joe User to create server-side filters without knowing anything about the language itself.

The plugin does not provide a parser; instead, it saves PHP meta-data in the script itself, in order to continue editing and manipulation of the filters. The only thing that is supported is a script called "phpscript" on the Cyrus server. Multiple scripts are not supported yet. I've tried to make it sane enough that it won't break a lot. Some more testing is needed - hence the beta status.

Status

This is beta software. It has been out for a while and is known to work pretty well. You'll have to check for yourselves if it is for a production environment. Features (and bugs) are added every other day. Insert standard GPL_Disclaimer(); here.

Features

This plugin provides:

• Simple HTML, no Javascript.
• Match messages based on email headers, size, or apply to all messages.
• Configurable number of header matches.
• Support of keeping a message, move to an existing or new folder, email redirection.
• Supports SIEVE Vacation.
• Supports SIEVE Notification action.
• Runs through all the rules, but supports a "stop" command when a rule matches.
• Change the order of rules - or delete them altogether.
• Make a textual description of the rule.
• Localizable.
• Automatic adaption to the capabilities of each site's SIEVE.

..but does not provide:

• A SIEVE parser.

Screenshots

If you'd like to take some quick look before installing, here are some screenshots of avelsieve in action:

Action to take in a rule

Header match definition

The table that lists all the rules

Requirements

• It has been tested with Cyrus IMAP server and its timsieved SIEVE parser.
• Squirrelmail version 1.4.0 or greater.
• sieve-php.lib, a PHP class for transporting SIEVE scripts, by Dan Ellis. Included.

License

Author