[Spambayes-checkins] website faq.txt,1.49,1.50
Tony Meyer
anadelonbrin at users.sourceforge.net
Thu Oct 16 17:21:02 EDT 2003
Update of /cvsroot/spambayes/website
In directory sc8-pr-cvs1:/tmp/cvs-serv14719
Modified Files:
faq.txt
Log Message:
Make the FAQ more accurately reflect current reality.
Index: faq.txt
===================================================================
RCS file: /cvsroot/spambayes/website/faq.txt,v
retrieving revision 1.49
retrieving revision 1.50
diff -C2 -d -r1.49 -r1.50
*** faq.txt 13 Oct 2003 21:30:56 -0000 1.49
--- faq.txt 16 Oct 2003 21:21:00 -0000 1.50
***************
*** 87,91 ****
------------------------------------
! There are four mailing lists which support SpamBayes:
1. The `SpamBayes list`_ provides a place for users to get help with
--- 87,91 ----
------------------------------------
! There are five mailing lists which support SpamBayes:
1. The `SpamBayes list`_ provides a place for users to get help with
***************
*** 102,105 ****
--- 102,111 ----
developers.
+ 5. The `SpamBayes bugs list`_ receives copies of all the bug, patch,
+ support requests and feature request reports that are submitted via the
+ `sourceforge`_ system. This is generally only of interest to developers
+ (you can use the sourceforge system to monitor any individual bugs that
+ you are interested in).
+
All the mailing lists are managed by Mailman, which uses pipermail to
archive messages. There is no search capability, so your best bet is to use
***************
*** 117,120 ****
--- 123,128 ----
.. _SpamBayes announcements list: http://mail.python.org/mailman/listinfo/spambayes-announce
.. _SpamBayes checkins list: http://mail.python.org/mailman/listinfo/spambayes-checkins
+ .. _SpamBayes bugs list: http://mail.python.org/mailman/listinfo/spambayes-bugs
+ .. _sourceforge: http://www.sourceforge.net
***************
*** 243,251 ****
instance.
! 7. The Hammie script. This does three jobs: command-line training, procmail
! filtering, and XML-RPC. See below for details of how to use Hammie for
! training, and how to use it as procmail filter. Hammie can also run as
an XML-RPC server, so that a programmer can write code that uses a remote
! server to classify emails programmatically - see hammiesrv.py.
8. The IMAP filter. This is a cross between the POP3 proxy and the Outlook
--- 251,259 ----
instance.
! 7. The filter script. This does three jobs: command-line training, procmail
! filtering, and XML-RPC. See below for details of how to use sb_filter for
! training, and how to use it as procmail filter. SpamBayes can also run as
an XML-RPC server, so that a programmer can write code that uses a remote
! server to classify emails programmatically - see sb_xmlrpcsrv.py.
8. The IMAP filter. This is a cross between the POP3 proxy and the Outlook
***************
*** 262,273 ****
-------------------------------
! The Hammie script is called hammie.py. The POP3 proxy lives in pop3proxy.py,
! and the smtpproxy lives in smtpproxy.py. The IMAP filter lives in
! imapfilter.py. The Outlook plug-in lives in the Outlook2000 subdirectory
! - see the README.txt in that directory for more information on that.
As well as these components, there's also a whole pile of utility scripts,
! test harnesses and so on - see README.txt and TESTING.txt in the
! SpamBayes distribution for more information.
--- 270,283 ----
-------------------------------
! The filter script is called sb_filter.py. The POP3 proxy lives in sb_server.py;
! to upload to the server use sb_upload.py. The IMAP filter lives in
! sb_imapfilter.py. These all live in the scripts directory - Windows users
! can find non-command-line versions in the windows directory. The Outlook
! plug-in lives in the Outlook2000 subdirectory - see the README.txt in that
! directory for more information on that.
As well as these components, there's also a whole pile of utility scripts,
! test harnesses and so on - see README.txt, README-DEVEL.txt and TESTING.txt
! in the SpamBayes distribution for more information.
***************
*** 284,295 ****
difficult to create a plugin for it.
! You can use pop3proxy and/or imapfilter with Outlook Express, however you
! must have either the alpha 3 release, or a recent CVS snapshot in order to
! do so (alpha 2 does not include all the necessary features). Because
Outlook Express does not let you filter on arbitrary headers (like
! X-Spambayes-Classification), pop3proxy must add the classification to the
"To:" line, or the "Subject" line.
! Pop3proxy/imapfilter aren't quite as 'transparent' as the Outlook plugin,
but they're still quite easy to use/setup, and they use the same core, so
the results will be the same. We are working on an alternative that should
--- 294,303 ----
difficult to create a plugin for it.
! You can use sb_server and/or sb_imapfilter with Outlook Express. Because
Outlook Express does not let you filter on arbitrary headers (like
! X-Spambayes-Classification), sb_server must add the classification to the
"To:" line, or the "Subject" line.
! sb_server/sb_imapfilter aren't quite as 'transparent' as the Outlook plugin,
but they're still quite easy to use/setup, and they use the same core, so
the results will be the same. We are working on an alternative that should
***************
*** 305,309 ****
:0fw
! | /opt/spambayes/hammiefilter.py
Follow that with a recipe to check the results and take action::
--- 313,317 ----
:0fw
! | /opt/spambayes/sb_filter.py
Follow that with a recipe to check the results and take action::
***************
*** 324,328 ****
(vm-save-message (expand-file-name "~/tmp/newspam"))
(vm-add-message-labels "trained" 1))
! (vm-pipe-message-to-command "hammiefilter.py -s >/dev/null" nil))
(defun train-as-nonspam ()
--- 332,336 ----
(vm-save-message (expand-file-name "~/tmp/newspam"))
(vm-add-message-labels "trained" 1))
! (vm-pipe-message-to-command "sb_filter.py -s >/dev/null" nil))
(defun train-as-nonspam ()
***************
*** 331,335 ****
(vm-save-message (expand-file-name "~/tmp/newham"))
(vm-add-message-labels "trained" 1))
! (vm-pipe-message-to-command "hammiefilter.py -g >/dev/null" nil))
(define-key vm-mode-map "ls" 'train-as-spam)
--- 339,343 ----
(vm-save-message (expand-file-name "~/tmp/newham"))
(vm-add-message-labels "trained" 1))
! (vm-pipe-message-to-command "sb_filter.py -g >/dev/null" nil))
(define-key vm-mode-map "ls" 'train-as-spam)
***************
*** 347,351 ****
IMAP_ proxies which are part of the SpamBayes source.
! .. _POP3: http://spambayes.sf.net/applications.html#pop3
.. _IMAP: http://spambayes.sf.net/applications.html#imap
--- 355,359 ----
IMAP_ proxies which are part of the SpamBayes source.
! .. _POP3: http://spambayes.sf.net/applications.html#sb_server
.. _IMAP: http://spambayes.sf.net/applications.html#imap
***************
*** 374,380 ****
modify.
! 3. Configure pop3proxy for each of Eudora's personalities' POP3 servers,
specifying a separate port for each. For example 1110, 1120, 1130 and
! 1140 for four personalities. Do the same for smtpproxy - for example
1115, 1125, 1135 and 1145 corresponding to the four POP3 servers.
--- 382,388 ----
modify.
! 3. Configure sb_server for each of Eudora's personalities' POP3 servers,
specifying a separate port for each. For example 1110, 1120, 1130 and
! 1140 for four personalities. Do the same for sb_smtpproxy - for example
1115, 1125, 1135 and 1145 corresponding to the four POP3 servers.
***************
*** 429,433 ****
Previous versions of the binary had a number of problems with various
versions of Outlook/Windows. However, to our knowledge, the current version
! should work with any combination of Windows/Outlook versions. Please let us
know if this is not the case. The `troubleshooting guide`_ for the Outlook
plugin contains the most up-to-date help for working around known problems.
--- 437,441 ----
Previous versions of the binary had a number of problems with various
versions of Outlook/Windows. However, to our knowledge, the current version
! should work with any combination of Windows/Outlook versions. Please let us
know if this is not the case. The `troubleshooting guide`_ for the Outlook
plugin contains the most up-to-date help for working around known problems.
***************
*** 435,441 ****
If you fall into that category, note that you must have applied all the
technical refreshes released by Microsoft to use the plugin successfully.
! Better yet, upgrade to the final version when it's available.
! .. _troubleshooting guide: http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/*checkout*/spambayes/spambayes/Outlook2000/docs/troubleshooting.html?rev=HEAD&content-type=text/plain
--- 443,449 ----
If you fall into that category, note that you must have applied all the
technical refreshes released by Microsoft to use the plugin successfully.
! Better yet, upgrade to the final version now that it's available.
! .. _troubleshooting guide: http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/*checkout*/spambayes/spambayes/Outlook2000/docs/troubleshooting.html?rev=HEAD&content-type=text/html
***************
*** 455,483 ****
--------------------------------------------------------
! This is a 'hidden' feature in the post 003 releases of the binary (also post
! alpha3 source releases and CVS). Details about how to enable this feature
! can be found in the "configuration.html" file in the "docs" directory in
! the folder SpamBayes was installed to. You can also set up mail that is
! trained using the "Delete as spam" button to be marked as read, rather than
! all mail classified as spam. However, you should also see the
! `envelope icon question`_.
.. _`envelope icon question`: #how-can-I-get-rid-of-the-envelope-tray-icon-for-spam
- Outlook forgets all training/configuration when I quit and start again
- ----------------------------------------------------------------------
-
- This is a known problem with the 002 release of the plug-in (or earlier).
- What is probably happening is that Outlook is not shutting down properly
- or completely, or is being forced to shut down too quickly. This version
- of the plug-in only saves training/configuration data on shut-down, so
- this can result in training/configuration being lost. To get around this
- problem, exit Outlook (not by restarting/shutting down the machine), and
- make sure that it is completely shut down (use the Task Manager to check).
- This should save your training and configuration. The 003 release (and
- later) saves as required, so avoids this issue.
-
-
Can I back up the Outlook database? Should I do this?
------------------------------------------------------
--- 463,473 ----
--------------------------------------------------------
! Yes, in version 008 and above of the plugin. You can find this on the
! filtering tab of the SpamBayes manager dialog. However, you should also
! see the `envelope icon question`_.
.. _`envelope icon question`: #how-can-I-get-rid-of-the-envelope-tray-icon-for-spam
Can I back up the Outlook database? Should I do this?
------------------------------------------------------
***************
*** 534,537 ****
--- 524,529 ----
4. Changed the action to "copy" or "move", rather than "untouched"
+ 5. Ticked the "enable SpamBayes" checkbox on the first tab of the dialog.
+
How can I get rid of the envelope tray icon for spam?
***************
*** 548,552 ****
Until someone comes up with a clever solution for all of this, you'll have to
! put up with the little envelope, sorry.
--- 540,545 ----
Until someone comes up with a clever solution for all of this, you'll have to
! put up with the little envelope, sorry. Note that there is a feature request
! already open for this, which you may add to if you have comments to make.
***************
*** 562,570 ****
require you to perform a full re-train.
Will "Show Spam Clues" notify a spammer that I opened their message?
--------------------------------------------------------------------
We think not (but we don't have the source code to Outlook to check
! for sure). In general, there are 2 ways spammers can determine this;
the first is via an automatic 'Read Receipt' (but this is unusual, as
the "from" address is generally forged so the receipt goes nowhere
--- 555,564 ----
require you to perform a full re-train.
+
Will "Show Spam Clues" notify a spammer that I opened their message?
--------------------------------------------------------------------
We think not (but we don't have the source code to Outlook to check
! for sure). In general, there are two ways spammers can determine this;
the first is via an automatic 'Read Receipt' (but this is unusual, as
the "from" address is generally forged so the receipt goes nowhere
***************
*** 618,622 ****
that it doesn't work as well with Western European language. It might work
very well with them if these default values are changed in the user's ini
! file:
[Tokenizer]
--- 612,617 ----
that it doesn't work as well with Western European language. It might work
very well with them if these default values are changed in the user's ini
! file (note that for Outlook users, this means the default_bayes_customize.ini
! file, rather than the one called Outlook.ini, or named after your profile):
[Tokenizer]
***************
*** 654,661 ****
number of spams as hams.
! You can train it on lots of messages in one go by either using the Hammie
script as explained in the "Command-line training" section, or by giving
messages to the web interface via the "Train" form on the Home page. You
! can train on individual messages (which is tedious) or using mbox files.
--- 649,657 ----
number of spams as hams.
! You can train it on lots of messages in one go by either using the sb_filter
script as explained in the "Command-line training" section, or by giving
messages to the web interface via the "Train" form on the Home page. You
! can train on individual messages (which is tedious), using mbox files or
! using Outlook Express dbx files.
***************
*** 668,681 ****
spambayes_spam at localhost, and if the message should have been classified as
ham, forward it to spambayes_ham at localhost. You can still review the
! training through the web interface, if you wish to do so.
!
! Note that you must set (via the web interface) the "add mail id to" option
! in order to use this. You can also use this id to find a particular message
! via the web interface.
Note that some mail clients (particularly Outlook Express) do not forward
! all headers when you bounce, forward or redirect mail. For these clients,
! you will need to set (via the web interface) the "add mail id to" option to
! body, which will add a unique id to the body of each message you receive.
--- 664,674 ----
spambayes_spam at localhost, and if the message should have been classified as
ham, forward it to spambayes_ham at localhost. You can still review the
! training through the web interface, if you wish to do so. You should ensure
! that the "lookup message in cache" option is set to True/Yes before you use
! this.
Note that some mail clients (particularly Outlook Express) do not forward
! all headers when you bounce, forward or redirect mail. We do not recommend
! using the SMTP proxy with these clients.
***************
*** 687,691 ****
containing nothing but ham, you can train SpamBayes using a command like::
! hammie.py -g ~/tmp/newham -s ~/tmp/newspam
The above command is OS-centric (e.g., UNIX, or Windows command prompt).
--- 680,684 ----
containing nothing but ham, you can train SpamBayes using a command like::
! sb_mboxtrain.py -g ~/tmp/newham -s ~/tmp/newspam
The above command is OS-centric (e.g., UNIX, or Windows command prompt).
***************
*** 703,707 ****
The plugin does *not* train on all incoming mail. However, if you use the
"Delete as spam" and "Recover from spam" buttons, those messages will be
! (re)trained as necessary.
--- 696,702 ----
The plugin does *not* train on all incoming mail. However, if you use the
"Delete as spam" and "Recover from spam" buttons, those messages will be
! (re)trained as necessary. If you have set it to use incremental training
! then it will also train on messages which are moved into the spam folder
! and those folders that you are 'watching'.
***************
*** 730,734 ****
never seen this particular flavor of spam before), or maybe there aren't
enough clues in the message which the system is aware of as strong spam
! clues.
--- 725,733 ----
never seen this particular flavor of spam before), or maybe there aren't
enough clues in the message which the system is aware of as strong spam
! clues. You should look at the clues that SpamBayes generated, and that
! should give you an idea of the reason for the classification. Both the
! web interface and the Outlook plug-in let you view the clues that make
! up the message. If you still can't figure out the reason why, you can
! ask the mailing list for advice.
***************
*** 806,810 ****
`bayescustomize.ini` or `.spambayesrc`. In here you can configure the name
and type of your database, your ham and spam cutoffs, and so on. The
! default values for all the options, and the documentation for them, lives
in Options.py.
--- 805,809 ----
`bayescustomize.ini` or `.spambayesrc`. In here you can configure the name
and type of your database, your ham and spam cutoffs, and so on. The
! default values for all the options, and the documentation for them, live
in Options.py.
***************
*** 892,896 ****
Sadly, not much is done in the way of testing these days. Hopefully this
will change, though, and if you're interested it's definately an option.
! Check out the README for information about how to get started. This is the
way to go if you have a new idea, too - even if you convince someone else to
develop it, we'll expect you to put in time to test its effectiveness.
--- 891,895 ----
Sadly, not much is done in the way of testing these days. Hopefully this
will change, though, and if you're interested it's definately an option.
! Check out the README-DEVEL for information about how to get started. This is the
way to go if you have a new idea, too - even if you convince someone else to
develop it, we'll expect you to put in time to test its effectiveness.
***************
*** 956,960 ****
"persistent_storage_file" option (also in the "Storage" section).
! If you specify your database on the command line ("pop3proxy.py -d hammie.db",
for example), then you should use the "-D" switch instead. Note, however,
that it is likely that these switches will change in a future release, and
--- 955,959 ----
"persistent_storage_file" option (also in the "Storage" section).
! If you specify your database on the command line ("sb_server.py -d hammie.db",
for example), then you should use the "-D" switch instead. Note, however,
that it is likely that these switches will change in a future release, and
***************
*** 987,991 ****
also do this via the web configuration, without having to alter the
configuration file manually. The option you are after is called
! ``Allowed remote connections``.
--- 986,991 ----
also do this via the web configuration, without having to alter the
configuration file manually. The option you are after is called
! ``Allowed remote connections``. In versions after 1.0a5, you can also
! set the interface to use HTTP-AUTH, either Basic or Digest.
***************
*** 993,1001 ****
------------------------------------------------------------------------------
! If you use pop3proxy or imapfilter, haven't set anything up, and run it and
get an error that ends with ``socket.error: (10013, 'Permission denied')``,
then this probably means that port 8880, which SpamBayes is trying to use to
present the web interface, is already taken on your machine. Try using
! ``pop3proxy.py -u 8881 -b`` (or ``imapfilter.py -u 8881 -b``), or another
port that you know is free and available on your machine.
--- 993,1001 ----
------------------------------------------------------------------------------
! If you use sb_server or sb_imapfilter, haven't set anything up, and run it and
get an error that ends with ``socket.error: (10013, 'Permission denied')``,
then this probably means that port 8880, which SpamBayes is trying to use to
present the web interface, is already taken on your machine. Try using
! ``sb_server.py -u 8881 -b`` (or ``sb_imapfilter.py -u 8881 -b``), or another
port that you know is free and available on your machine.
More information about the Spambayes-checkins
mailing list