SMARTSIEVE SIEVE SCRIPT MANAGER
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

SmartSieve-1.0

SmartSieve is a web based graphical user interface for creating and 
managing Sieve scripts on a sieve-enabled mail server. It provides a 
way for non-technical email users to generate Sieve rules for mail 
filtering and vacation messaging without prior knowledge of the 
Sieve scripting language. SmartSieve is written in PHP and is 
intended to be intuitive to use, and simple to configure.

SmartSieve will be of interest to institutions running Cyrus imapd 
or Dovecot to provide imap based mail access and who require a 
user-friendly way for users to manage mail filtering and vacation 
messaging.

SmartSieve is not a Sieve script 'parser'. It cannot directly read 
and understand the Sieve language itself. For this reason, the GUI 
will only work for Sieve scripts created by SmartSieve. Other 
non-SmartSieve scripts can be edited in SmartSieve's direct edit 
mode.


PROJECT STATUS

At the time of this release, SmartSieve version 1.0 is considered 
stable. See the requirements section of the INSTALL file for details 
of the versions of PHP and Cyrus that SmartSieve is known to work 
with. We cannot guarantee SmartSieve will work on all platforms or 
older versions of PHP and Cyrus. The SmartSieve Project does not 
accept responsibility for any loss or damage which might occur as a 
result of using this software.

Please feel free to give SmartSieve a whirl. The SmartSieve project 
always appreciates feedback, so please let us know of any comments, 
bugs or suggestions you may have. See the support section for methods 
of providing feedback. Also, if you wish to contribute in some way, 
or provide a new translation, see the section on contributing.

You should check the SmartSieve project web site for the latest news 
and release information. It is at:

http://smartsieve.sourceforge.net


INSTALLING SMARTSIEVE

Instruction for installing SmartSieve can be found in the INSTALL 
file included in this distribution.


LICENSE AND COPYRIGHT

SmartSieve is free open source software released under the GNU 
General Public License. Please see the NOTICE file for conditions of 
the use and distribution of SmartSieve, and also the COPYING file for 
licensing and copyright information. Both of these files should be 
included in the SmartSieve distribution.


SUPPORT

If you require assistance with SmartSieve, or you wish to report a 
bug, make a suggestion, or if you wish to contribute, you should go 
via the project web site:

http://sourceforge.net/projects/smartsieve/

There is a mailing list for the project. You can view the archives, 
subscribe or get further information at:

http://lists.sourceforge.net/lists/listinfo/smartsieve-general

There is a support request tracker for the SmartSieve project. You can 
browse it at:

http://sourceforge.net/tracker/?atid=501286&group_id=62641&func=browse

You can submit bug reports or browse the bug tracker at:

https://sourceforge.net/tracker/?group_id=62641&atid=501285


CONTRIBUTING

Contributions to the SmartSieve project are always welcome. If you want 
to contribute in some way then the first thing you should do is subscribe 
to the smartsieve-general mailing list. Send a message to the list 
explaining what you plan to do to make sure you don't duplicate work being 
done by someone else, or that has already been added. The TODO file in the 
SmartSieve distribution contains a list of tasks to be done.

If you're contributing code make sure you are working on the most recent 
code base. Check out the latest version from the CVS. There are instructions 
on doing this at:

http://sourceforge.net/cvs/?group_id=62641

Code should be contributed in the form of a patch, preferably generated 
using GNU diff, and should be sent to the smartsieve-general mailing list.


TRANSLATING

SmartSieve includes support for internationalization (i18n). If you want 
to translate SmartSieve into another language, first check a translation 
in that language does not already exist. Translations live under 
conf/locale/[locale name], where locale name is formed from the two digit 
language code (see ISO 639) and the two digit country code (see ISO 3166), 
eg en_GB.

To create the translation, you should use the locales_update.pl script in 
the scripts directory of the SmartSieve distribution. First, create the 
directory for the locale you are creating a translation for, and then run 
the locales_update script:

$ cd smartsieve/
$ mkdir conf/locale/en_GB
$ cd scripts/
$ ./locales_update.pl en_GB

This will create a strings.php.new file containing all the strings to be 
translated. If there is an existing strings.php translations file, it will 
extract any existing translations. You will need to edit this file and 
complete all the necessary translations, and then copy the strings.php.new 
file to strings.php.

Add appropriate entries for your new locale to the conf/locales.php file. 
If your translation uses a character set other than iso-5589-1 you will 
need to specify it in this file.

Then send a copy of your translations file to the smartsieve-general list 
to share it with the rest of us! Don't forget to indicate what charset the 
translation uses.



$Id$