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).

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.

Notice: change in the creation and handling of header-type filtering rules will mean that the existing rules that your users have probably created in the pre-0.6 era will not be displayed anymore. This might not be catastrophic, but it would be better for the users to recreate the scripts anyway, to avoid any confusion.

About this implementation

The web interface provides a wizard-like interface that, in the end, creates part of a SIEVE script, a 'rule' as I call it. It then assembles all the rules to form a SIEVE script.

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.

I haven't followed the Squirrelmail coding style, sorry. I use tabs. :)

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:

..but does not provide:

Features with Seniority (Bugs)

Screenshots

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

[action.png]
Action to take in a rule
[headermatch.png]
Header match definition
[table.png]
The table that lists all the rules

Demo

Aside from the screenshots above, you can see the plugin in action, if you wish. Check the Live Demo page for more information.

Requirements

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

TODO / Plan

There's still a lot of stuff to do. If anyone wants to help, you are mostly welcome!

Author

Alexandros Vellis, Network Operations Centre, University of Athens
(Personal home page).

Translators:

Thanks, Credits