0.8.9claws18
[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 send to a
6 spamd server that decides if the message is spam or not.
7
8 To build the plugin run configure with --enable-spamassassin-plugin
9
10 Message that are classified as spam can be deleted or moved to a folder
11 that can be specified in the configuration, if the folder is not
12 specified or not found the default trash folder will be used.
13
14 Please note that the spamassassin.so plugin only provides the actual
15 filtering. By default it is not enabled. You probably want to load the
16 spamassassin_gtk.so plugin too to get a configuration page under
17 "Configuration/Other Preferences..." for the SpamAssassin plugin.
18
19 The SpamAssassin plugin uses it's own block in the sylpheedrc file in your
20 ~/.sylpheed directory. If you really want to configure it without the GTK
21 plugin you can specify the following options:
22
23 [SpamAssassin]
24 enable=1                                enable filtering with SpamAssassin
25                                         [default: 0]
26
27 hostname=localhost                      hostname of the spamd server
28                                         [default: localhost]
29
30 port=783                                port the spamd server uses
31                                         [default: 783]
32
33 max_size=250                            maximum size a mail can have (in kB)
34                                         larger mails will not be filtered
35                                         [default: 250]
36
37 receive_spam=1                          enable to save spam to a mailfolder
38                                         if not enabled the mails will be deleted,
39                                         please note that this is dangerout and you
40                                         might lose an important mail that is
41                                         classified as spam by mistake
42                                         [default: 1]
43
44 save_folder=#mh/Mail/trash/Spam         the folder that should be used to save
45                                         spam mails, if empty the default trash
46                                         folder is used
47                                         [default: none, use default trash]
48
49 libspamc.[ch] and utils.[ch] are files from the SpamAssassin distribution.
50 The copyright holders and license information can be found inside the files.
51 The SpamAssassin distribution can be downloaded from http://www.spamassassin.org/