2006-03-04 [wwp] 2.0.0cvs107
authorTristan Chabredier <wwp@claws-mail.org>
Sat, 4 Mar 2006 09:29:57 +0000 (09:29 +0000)
committerTristan Chabredier <wwp@claws-mail.org>
Sat, 4 Mar 2006 09:29:57 +0000 (09:29 +0000)
* manual/plugins.xml
* src/plugins/spamassassin/README
updated SpamAssassin plugin docs to reflect new functional additions
(also fix/update/documents few technical stuff more, see the README).

ChangeLog
PATCHSETS
configure.ac
manual/plugins.xml
src/plugins/spamassassin/README

index 723f66c..0f47b38 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2006-03-04 [wwp]       2.0.0cvs107
+
+       * manual/plugins.xml
+       * src/plugins/spamassassin/README
+               updated SpamAssassin plugin docs to reflect new functional additions
+               (also fix/update/documents few technical stuff more, see the README).
+
 2006-03-04 [wwp]       2.0.0cvs106
 
        * src/prefs_message.c
index c3e6dc8..caf1337 100644 (file)
--- a/PATCHSETS
+++ b/PATCHSETS
 ( cvs diff -u -r 1.9.2.16 -r 1.9.2.17 src/plugins/clamav/clamav_plugin_gtk.c;  ) > 2.0.0cvs104.patchset
 ( cvs diff -u -r 1.1.2.10 -r 1.1.2.11 manual/advanced.xml;  ) > 2.0.0cvs105.patchset
 ( cvs diff -u -r 1.1.2.12 -r 1.1.2.13 src/prefs_message.c;  ) > 2.0.0cvs106.patchset
+( cvs diff -u -r 1.1.2.6 -r 1.1.2.7 manual/plugins.xml;  cvs diff -u -r 1.3 -r 1.4 src/plugins/spamassassin/README;  ) > 2.0.0cvs107.patchset
index f3f90c9..5093664 100644 (file)
@@ -11,7 +11,7 @@ MINOR_VERSION=0
 MICRO_VERSION=0
 INTERFACE_AGE=0
 BINARY_AGE=0
-EXTRA_VERSION=106
+EXTRA_VERSION=107
 EXTRA_RELEASE=
 EXTRA_GTK2_VERSION=
 
index 3f5798d..66495f4 100644 (file)
            <listitem><para>Handles PGP signed and/or encrypted mails. You can decrypt mails, verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/">ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.</para></listitem>
     </varlistentry>
     <varlistentry><term>SpamAssassin</term>
-           <listitem><para>Enables the scanning of incoming mail received from a POP, IMAP or LOCAL account using SpamAssassin. It can optionally delete mail identified as spam or save it to a designated folder. Preferences can be found in <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>. SpamAssassin is available from <ulink url="http://spamassassin.org/">http://spamassassin.org/</ulink>.</para></listitem>
+           <listitem>
+                       <para>The SpamAssassin plugin comes with two major features:</para>
+                       <para>The ability to scan incoming mail received from a POP, IMAP or LOCAL account using SpamAssassin, this can be turned off. It can optionally delete mail identified as spam or save it to a designated folder.</para>
+                       <para>The ability for users to teach SpamAssassin to recognise spam or ham. You can train SpamAssassin by marking messages as spam or ham from the message list contextual menu, or using the relevant toolbar button in the main window or the message window (see "Configuration/Preferences/Customize toolbars"). Messages marked as spam are optionally saved to a designated folder.</para>
+                       <para>Plugin preferences can be found in "Configuration/Preferences/Plugins/SpamAssassin".</para>
+                       <para>SpamAssassin is available from <ulink url="http://spamassassin.apache.org/">http://spamassassin.apache.org/</ulink>. Version 3.1.x or higher is required to use the learning feature in TCP mode.</para>
+               </listitem>
     </varlistentry>
     <varlistentry><term>Trayicon</term>
            <listitem><para>Places an icon in the system tray that indicates whether you have any new mail. A tooltip also shows the current new, unread and total number of messages.</para></listitem>
index a8f2a5c..b2a04b0 100644 (file)
@@ -2,26 +2,34 @@ SpamAssassin Plugin
 -------------------
 
 This plugin will filter incoming messages using SpamAssassin. Like the
-spamc command from the SpamAssassin package the message is send to a
-spamd server that decides if the message is spam or not.
+spamc command from the SpamAssassin package, the message is sent to a
+spamd server that decides if the message is spam or not. Filtering of
+spam at incorporation time can be turned off.
 
-To build the plugin run configure with --enable-spamassassin-plugin
+The plugin also provides the ability to teach spamd to recognize spam and ham,
+using the external command sa-learn in local modes or spamc in TCP mode
+(this one requires SpamAssassin >=3.1.x). A toolbar button for marking
+messages as spam or ham can be added to the main window or the message
+window (see "Configuration/Preferences/Customize toolbars).
+
+To build the plugin run configure with --enable-spamassassin-plugin.
 
 Message that are classified as spam can be deleted or moved to a folder
 that can be specified in the configuration, if the folder is not
 specified or not found the default trash folder will be used.
 
-Please note that the spamassassin.so plugin only provides the actual
-filtering. By default it is not enabled. You probably want to load the
-spamassassin_gtk.so plugin too to get a configuration page under
-"Configuration/Other Preferences..." for the SpamAssassin plugin.
+Plugin preferences can be found under "Configuration/Preferences/Plugins
+/SpamAssassin". 
 
 The SpamAssassin plugin uses it's own block in the sylpheedrc file in your
-~/.sylpheed directory. If you really want to configure it without the GTK
-plugin you can specify the following options:
+~/.sylpheed-claws/ directory, and define the following options:
 
 [SpamAssassin]
-enable=1                               enable filtering with SpamAssassin
+transport=0                            transport type (to reach spamd)
+                                       0 is to disable all features
+                                       1 is using a local spamd
+                                       2 is using a TCP connection
+                                       3 is using a Unix socket
                                        [default: 0]
 
 hostname=localhost                     hostname of the spamd server
@@ -30,10 +38,17 @@ hostname=localhost                  hostname of the spamd server
 port=783                               port the spamd server uses
                                        [default: 783]
 
+timeout=30                             max time (in seconds) a transaction with spamd
+                                       should last
+                                       [default: 30]
+
 max_size=250                           maximum size a mail can have (in kB)
                                        larger mails will not be filtered
                                        [default: 250]
 
+process_emails=1                       enable to filter incoming emails (POP, IMAP, local)
+                                       [default: 1]
+
 receive_spam=1                         enable to save spam to a mailfolder
                                        if not enabled the mails will be deleted,
                                        please note that this is dangerout and you
@@ -46,6 +61,9 @@ save_folder=#mh/Mail/trash/Spam               the folder that should be used to save
                                        folder is used
                                        [default: none, use default trash]
 
+username=<empty>                       user the spamd server have to use
+                                       [default: user name of the current user]
+
 libspamc.[ch] and utils.[ch] are files from the SpamAssassin distribution.
 The copyright holders and license information can be found inside the files.
-The SpamAssassin distribution can be downloaded from http://www.spamassassin.org/
+The SpamAssassin distribution can be downloaded from http://spamassassin.apache.org/.