add Clam AntiVirus plugin
[claws.git] / src / plugins / clamav / README
1 Clam AntiVirus Plugin
2 ---------------------
3
4 This plugin will scan incoming messages for viruses using 
5 Clam AntiVirus.
6
7 To build the plugin run configure with --enable-clamav-plugin
8
9 Messages that have infected attachments can be deleted or moved
10 to a folder that can be specified in the configuration, if the
11 folder is not specified or not found the default trash folder will
12 be used.
13
14 Please note that the clamav_plugin.so plugin only provides the
15 actual scanning. By default it is not enabled. You probably also 
16 want to load the clamav_plugin_gtk.so to get a configuration page
17 under "Configuration/Other Preferences..." for the Clam AntiVirus
18 plugin.
19
20 The Clam AntiVirus plugin uses its own block in the sylpheedrc file
21 in your ~/.sylpheed directory. If you really want to configure it
22 without the GTK plugin you can specify the following options:
23
24 [ClamAV]
25 clamav_enable=1                         enable scanning with Clam AntiVirus
26                                         [default: 0]
27
28 clamav_enable_archive=1                 enable archive scanning with Clam 
29                                         AntiVirus
30                                         [default: 0]
31
32 clamav_max_size=1                       maximum size an attachment can have
33                                         (in MB), larger attachments will not
34                                         be scanned
35                                         [default: 1]
36
37 clamav_receive_infected=1               enable to save infected messages to a 
38                                         mailfolder. If not enabled the mails will 
39                                         be deleted
40                                         [default: 1]
41 clamav_save_folder=#mh/Mailbox/virus    the folder that should be used to save
42                                         infected mails, if empty the default 
43                                         trash folder is used
44                                         [default: none, use default trash]
45
46 Clam AntiVirus is licensed under the GPL and can be downloaded from
47 http://clamav.elektrapro.com/