RSSyl: Allow use of .netrc by libcurl. Bug/enhancement #3309, by Vincent Pelletier
[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 The plugin is built automatically if you have the required libraries
16 available.
17
18 Message that are classified as spam can be deleted or moved to a folder
19 that can be specified in the configuration, if the folder is not
20 specified or not found the default trash folder will be used.
21
22 Plugin preferences can be found under "/Configuration/Preferences/Plugins
23 /SpamAssassin". 
24
25 The SpamAssassin plugin uses it's own block in the clawsrc file in your
26 ~/.claws-mail/ directory, and define the following options:
27
28 [SpamAssassin]
29 transport=0                             transport type (to reach spamd)
30                                         0 is to disable all features
31                                         1 is using a local spamd
32                                         2 is using a TCP connection
33                                         3 is using a Unix socket
34                                         [default: 0]
35
36 hostname=localhost                      hostname of the spamd server
37                                         [default: localhost]
38
39 port=783                                port the spamd server uses
40                                         [default: 783]
41
42 timeout=30                              max time (in seconds) a transaction with spamd
43                                         should last
44                                         [default: 30]
45
46 max_size=250                            maximum size a mail can have (in kB)
47                                         larger mails will not be filtered
48                                         [default: 250]
49
50 process_emails=1                        enable to filter incoming emails (POP, IMAP, local)
51                                         [default: 1]
52
53 receive_spam=1                          enable to save spam to a mailfolder
54                                         if not enabled the mails will be deleted,
55                                         please note that this is dangerout and you
56                                         might lose an important mail that is
57                                         classified as spam by mistake
58                                         [default: 1]
59
60 save_folder=#mh/Mail/trash/Spam         the folder that should be used to save
61                                         spam mails, if empty the default trash
62                                         folder is used
63                                         [default: none, use default trash]
64
65 username=<empty>                        user the spamd server have to use
66                                         [default: user name of the current user]
67
68 libspamc.[ch] and utils.[ch] are files from the SpamAssassin distribution.
69 The copyright holders and license information can be found inside the files.
70 The SpamAssassin distribution can be downloaded from http://spamassassin.apache.org/.