Read Me

Welcome to SpamAssassin Coach!
------------------------------

What Is SpamAssassin Coach?
---------------------------

SpamAssassin Coach provides additional functionality to SpamAssassin by allowing
users to learn messages as spam or ham from the comfort of their own inbox.  
Currently, SpamAssassin Coach is available as an add-in for Microsoft Outlook 
and Mozilla Thunderbird.

SpamAssassin Coach is a project of the Apache Software Foundation (ASF) and was
developed for Google's Summer of Code by William Duff.

Building SpamAssassin Coach
---------------------------

a) Mozilla Thunderbird

   Mozilla Thunderbird extensions are packaged and distributed in ZIP files with 
   the .xpi and .jar file extensions. The structure of the SpamAssassin Coach 
   .xpi file is detailed below:
   
   spamassassincoach.xpi:
                         /chrome/spamd.jar:
                                           /content/options.xul
                                           /content/spamd.js
                                           /content/toolbarOverlay.xul
                                           /locale/en-US/spamd.dtd
                                           /skin/icon.png
                                           /skin/icon16.png
                                           /skin/icon24.png
                                           /skin/spamd.css
                         /defaults/preferences/defaults.js
                         /chrome.manifest
                         /install.rdf

b) Microsoft Outlook

   Compile the source files with Microsoft Visual C# .NET.
		

Installing SpamAssassin Coach
-----------------------------

a) Mozilla Thunderbird

   Prerequisites:  Mozilla Thunderbird 1.5 or above

   Open Mozilla Thunderbird and go to Tools -> Extensions.  Then click Install
   and browse to the SpamAssassin Coach .xpi file.  Restart Mozilla Thunderbird
   to complete the installation.

b) Microsoft Outlook

   Prerequisites:  Microsoft Outlook 2000 or later
                   .NET Framework 1.1 and 2.0
                   Collaboration Data Objects (CDO) library
                   (CDO must be installed from the Microsoft Office CD)

   Just double-click on the SpamAssassin Coach .msi file and follow the
   instructions.

Known Issues
------------

a) Mozilla Thunderbird

	1)  On startup, a Javascript error is thrown with the message: 
	    "msgpane has no properties."  This error does not affect the use of 
	    SpamAssassin Coach.

b) Microsoft Outlook

	1)  Messages sent to be learned or forgotten will not include any 
	    attachments.
	    
	2)  The SpamAssassin Coach button stays in the Outlook toolbar after
	    uninstallation.  The button can be removed by choosing to reset the
	    toolbar to default.