================================
====== Table of Contents  ======
================================
1.- Disclaimer
2.- What is zSpam for?
3.- Compatibility
4.- Installing zSpam
5.- Configuring zSpam
6.- Using zSpam
7.- Support - Contribution

-----------------------------------------------------------------
----------------- 1.- Disclaimer                 ----------------
-----------------------------------------------------------------
This software is under Apache v2 License. Please read LICENSE file
for further information.

-----------------------------------------------------------------
----------------- 2.- What's zSpam for?         ----------------
-----------------------------------------------------------------
 zSpam is designed to report spam emails into some well known
 CNETs.

-----------------------------------------------------------------
----------------- 3.- Compatibility              ----------------
-----------------------------------------------------------------
 zSpam has been tested in 
  - ZCS 6.x and 7.x (Web Client)
  - pyzor 1:0.4.0
  - razor 1:2.85-1
  - dcc	  1.3.141

-----------------------------------------------------------------
----------------- 4.- Installing zSpam          ----------------
-----------------------------------------------------------------
 Refer to INSTALL file for intructions of how to install this
 zimlet.

 This zimlet lets the reporting task to each of the CNET original
 tools, so you must install them if you want to report anything.

- Razor:
	* Many distros has razor already packaged.
	* Razor available from
        	http://razor.sourceforge.net/download/

- Pyzor:
	* Many distros has razor already packaged.
	* Also available at 
		https://sourceforge.net/project/showfiles.php?group_id=50000

- DCC:
	* Can be installed from:
	    http://www.rhyolite.com/anti-spam/dcc/source/dcc.tar.Z 
	* There is no revocation support in DCC.

-----------------------------------------------------------------
----------------- 5.- Configuring zSpam         ----------------
-----------------------------------------------------------------
 There is no global configuration for zSpam, each user must 
 configure it separately.

 If zSpam has been correctly deployed, after loggin in zimbra, 
 a new icon should apperar in the left panel. Just click it and 
 a configuration window should appear with the following fields:

 CNET Options: Select what CNETs you want to use. 
	zSpam will try to identify what tools you have
	installed and allow you to only use that CNETs.
 Move spam to 'Spam' folder: Move marked spam to junkie folder
 Don't override Spam button: By default, we replace the Spam button
 	provided by Zimbra. This option will show both Zimbra and
	zSpam button
 Razor Username/Passwor: Razor CNET requires authentication to be
 	used. Just put an email address an password and press
	register.
 Mark spam with tag: Set the tag name that will be used 
	to tag spam makred emails. If this field is empty, emails
	won't be tagged. This feature only works from the moment
	it is "activated", so previously marked emails won't 
	be tagged.
 
-----------------------------------------------------------------
----------------- 6.- Using zSpam               ----------------
-----------------------------------------------------------------
 There are three ways to access zSpam screen:

 - Using the Zimlet panel: 
   Just Drag a conversation or email and drop in the zSpam icon.

 - Using Toolbar Button:
   Select a conversation or email and click 'Spam'
   toolbar button.

 - Using the context menu option:
   Rigth click a conversation or email and click 'Spam' option.

-----------------------------------------------------------------
----------------- 7.- Support - Contribution     ----------------
-----------------------------------------------------------------
 This zimlet has been developed by Irontec S.L.
	http://www.irontec.com

 Contact with any of the developers:
 	Kaian - kaian@irontec.com

