2006-03-04 [wwp] 2.0.0cvs107
[claws.git] / src / plugins / spamassassin / README
1 SpamAssassin Plugin
2 -------------------
3
4 This plugin will filter incoming messages using SpamAssassin. Like the
5 spamc command from the SpamAssassin package, the message is sent to a
6 spamd server that decides if the message is spam or not. Filtering of
7 spam at incorporation time can be turned off.
8
9 The plugin also provides the ability to teach spamd to recognize spam and ham,
10 using the external command sa-learn in local modes or spamc in TCP mode
11 (this one requires SpamAssassin >=3.1.x). A toolbar button for marking
12 messages as spam or ham can be added to the main window or the message
13 window (see "Configuration/Preferences/Customize toolbars).
14
15 To build the plugin run configure with --enable-spamassassin-plugin.
16
17 Message that are classified as spam can be deleted or moved to a folder
18 that can be specified in the configuration, if the folder is not
19 specified or not found the default trash folder will be used.
20
21 Plugin preferences can be found under "Configuration/Preferences/Plugins
22 /SpamAssassin". 
23
24 The SpamAssassin plugin uses it's own block in the sylpheedrc file in your
25 ~/.sylpheed-claws/ directory, and define the following options:
26
27 [SpamAssassin]
28 transport=0                             transport type (to reach spamd)
29                                         0 is to disable all features
30                                         1 is using a local spamd
31                                         2 is using a TCP connection
32                                         3 is using a Unix socket
33                                         [default: 0]
34
35 hostname=localhost                      hostname of the spamd server
36                                         [default: localhost]
37
38 port=783                                port the spamd server uses
39                                         [default: 783]
40
41 timeout=30                              max time (in seconds) a transaction with spamd
42                                         should last
43                                         [default: 30]
44
45 max_size=250                            maximum size a mail can have (in kB)
46                                         larger mails will not be filtered
47                                         [default: 250]
48
49 process_emails=1                        enable to filter incoming emails (POP, IMAP, local)
50                                         [default: 1]
51
52 receive_spam=1                          enable to save spam to a mailfolder
53                                         if not enabled the mails will be deleted,
54                                         please note that this is dangerout and you
55                                         might lose an important mail that is
56                                         classified as spam by mistake
57                                         [default: 1]
58
59 save_folder=#mh/Mail/trash/Spam         the folder that should be used to save
60                                         spam mails, if empty the default trash
61                                         folder is used
62                                         [default: none, use default trash]
63
64 username=<empty>                        user the spamd server have to use
65                                         [default: user name of the current user]
66
67 libspamc.[ch] and utils.[ch] are files from the SpamAssassin distribution.
68 The copyright holders and license information can be found inside the files.
69 The SpamAssassin distribution can be downloaded from http://spamassassin.apache.org/.