ae9b9c6cda0ac06ba7e146d67f2339703f616501
[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 libspamc.[ch] and utils.[ch] are copied from the SpamAssassin package. I
15 hope SpamAssassin will provide their functions as a library with the
16 required includes files in the future for easier building. Building the
17 library as a shared object is already possible, but it is not installable
18 with the package and the includes are also not available.
19
20 Please note that the spamassassin.so plugin only provides the actual
21 filtering. By default it is not enabled. You probably want to load the
22 spamassassin_gtk.so plugin too to get a configuration page under
23 "Configuration/Other Preferences..." for the SpamAssassin plugin.
24
25 The SpamAssassin plugin uses it's own block in the sylpheedrc file in your
26 ~/.sylpheed directory. If you really want to configure it without the GTK
27 plugin you can specify the following options:
28
29 [SpamAssassin]
30 enable=1                                enable filtering with SpamAssassin
31                                         [default: 0]
32
33 hostname=localhost                      hostname of the spamd server
34                                         [default: localhost]
35
36 port=783                                port the spamd server uses
37                                         [default: 783]
38
39 max_size=250                            maximum size a mail can have (in kB)
40                                         larger mails will not be filtered
41                                         [default: 250]
42
43 receive_spam=1                          enable to save spam to a mailfolder
44                                         if not enabled the mails will be deleted,
45                                         please note that this is dangerout and you
46                                         might lose an important mail that is
47                                         classified as spam by mistake
48                                         [default: 1]
49
50 save_folder=#mh/Mail/trash/Spam         the folder that should be used to save
51                                         spam mails, if empty the default trash
52                                         folder is used
53                                         [default: none, use default trash]