src/plugins/clamav/README

   1 Clam AntiVirus Plugin
   2 ---------------------
   3
   4 This plugin will scan incoming messages for viruses using
   5 Clam AntiVirus (libclamav). It can be used with Local, IMAP
   6 and POP accounts.
   7
   8 Messages that have infected attachments can be automatically
   9 deleted or moved to a folder that can be specified in the
  10 configuration, if the folder is not specified or not found
  11 the default trash folder will be used.
  12
  13 The plugin is built automatically if you have the required
  14 libraries available. It has two parts and will be installed
  15 in $PREFIX/lib/sylpheed/plugins/ as clamav_plugin.so and
  16 clamav_plugin_gtk.so.
  17
  18 The 'clamav_plugin.so' plugin provides only the actual
  19 scanning. By default it is not enabled.
  20
  21 You will probably also want to load the configuration plugin
  22 'clamav_plugin_gtk.so' to get a configuration page under
  23 "Configuration/Other Preferences.../Filtering/Clam AntiVirus"
  24 for the Clam AntiVirus plugin.
  25
  26 The Clam AntiVirus plugin uses its own block in the 'sylpheedrc'
  27 file in your config directory (default: '~/.sylpheed'). If you
  28 really want to configure it without the GTK plugin you can
  29 specify the following options:
  30
  31 [ClamAV]
  32 clamav_enable=1                         enable scanning with Clam AntiVirus
  33                                         [default: 0]
  34
  35 clamav_enable_arc=1                     enable archive scanning with Clam
  36                                         AntiVirus
  37                                         [default: 0]
  38
  39 clamav_max_size=1                       maximum size an attachment can have
  40                                         (in MB), larger attachments will not
  41                                         be scanned
  42                                         [default: 1]
  43
  44 clamav_recv_infected=1                  enable to save infected messages to a
  45                                         mailfolder. If not enabled the mails
  46                                         will be deleted
  47                                         [default: 1]
  48
  49 clamav_save_folder=#mh/Mailbox/virus    the folder that should be used to save
  50                                         infected mails, if empty the default
  51                                         trash folder is used
  52                                         [default: none, use default trash]
  53
  54 Clam AntiVirus is licensed under the GPL and can be downloaded from
  55 http://clamav.sourceforge.net/