[Spambayes-checkins] spambayes/Outlook2000 README.txt,1.2,1.3

[Mark Hammond]

Update of /cvsroot/spambayes/spambayes/Outlook2000
In directory usw-pr-cvs1:/tmp/cvs-serv14495

Modified Files:
	README.txt 
Log Message:
Information on how to use this baby.


Index: README.txt
===================================================================
RCS file: /cvsroot/spambayes/spambayes/Outlook2000/README.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** README.txt	19 Oct 2002 16:23:37 -0000	1.2
--- README.txt	20 Oct 2002 08:42:37 -0000	1.3
***************
*** 1,5 ****
  This directory contains tools for using the classifier with Microsoft
  Outlook 2000, courtesy of Sean True and Mark Hammond.  Note that you need 
! Python's win32com extensions (http://starship.python.net/crew/mhammond)
  
  ** NOTE ** - You also need CDO installed.  This comes with Outlook 2k, but is
--- 1,6 ----
  This directory contains tools for using the classifier with Microsoft
  Outlook 2000, courtesy of Sean True and Mark Hammond.  Note that you need 
! Python's win32com extensions (http://starship.python.net/crew/mhammond) and
! to run the Outlook Addin you *must* have win32all-149 or later.
  
  ** NOTE ** - You also need CDO installed.  This comes with Outlook 2k, but is
***************
*** 8,17 ****
  compaining about "MAPI.Session", this is your problem.
  
  train.py
      Train a classifier from Outlook Mail folders.
  
  filter.py
!     Moves and modifies msgs among Outlook Mail folders, based on classifier 
!     score.
  
  classify.py
--- 9,62 ----
  compaining about "MAPI.Session", this is your problem.
  
+ Outlook Addin
+ ==========
+ If you execute "addin.py", a Microsoft Outlook plugin will be installed.
+ Next time outlook is started, you should see a "Anti-Spam" button
+ on the toolbar.  Clicking it will allow you to maintain your bayes database
+ and filters.
+ 
+ All functionality in this package can be accessed from this plugin. This
+ directory contains a number of other files (see below) which can be
+ used to access features of the bayes database and filters from outside
+ of the Outlook environment.  Either way, the functionality is the same.
+ 
+ To see any output from the addin (eg, Python print statements) you can either
+ select "Tools->Trace Collector Debugging Tool" from inside Pythonwin, or just
+ execute win32traceutil.py (from the win32all extensions) from a Command 
+ Prompt.
+ 
+ NOTE: If the addin fails to load, Outlook will automatically disable it
+ for the next time Outlook starts.  Re-executing 'addin.py' will ensure
+ the addin is enabled.
+ 
+ Filtering
+ --------
+ When running from Outlook, you can enable filtering for all mail that arrives 
+ in your Inbox (or any other filter).  Note that Outlook's builtin rules will 
+ fire before this notification, and if these rules move the message, it will
+ never appear in the inbox (and thus will not get spam-filtered by a simple
+ Inbox filter)
+ 
+ You can define any number of filters to apply, each performing a different 
+ action or testing a different spam probability.  You can enable and disable
+ any rules, and you can "bulk-apply" a filter to an entire folder.
+ 
+ Note that the rule ordering can be important, as if early rules move
+ a message, later rules will not fire for that message.
+ 
+ Command Line Tools
+ -------------------
+ There are a number of scripts that invoke the same GUI as the
+ Outlook plugin.
+ 
+ manager.py
+     Display the main dialog, which provides access to all other features.
+ 
  train.py
      Train a classifier from Outlook Mail folders.
  
  filter.py
!     Define filters, and allow a bulk-filter to be applied.  (The outlook 
!     plugin must be running for filtering of new mail to occur)
  
  classify.py
***************
*** 20,29 ****
      or used to change formatting of these messages.  The field will appear
      in "user defined fields"
-     
- Comments from Sean:
  
- This code is extremely rudimentary.
  
! I am getting bad output saving very large classifiers in training.py.
  Somewhere over 4MB, they seem to stop working.
  
--- 65,73 ----
      or used to change formatting of these messages.  The field will appear
      in "user defined fields"
  
  
! Misc Comments
! ===========
! Sean reports bad output saving very large classifiers in training.py.
  Somewhere over 4MB, they seem to stop working.