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 will be installed in
  15 $PREFIX/lib/claws-mail/plugins/ as clamav_plugin.so.
  16
  17 Configuration preferences are found on the
  18 "/Configuration/Preferences.../Plugins/Clam AntiVirus" page.
  19
  20 The Clam AntiVirus plugin uses its own block in the 'clawsrc'
  21 file in your config directory (default: '~/.claws-mail'). It
  22 has the following options:
  23
  24 [ClamAV]
  25 clamav_enable=1                         enable scanning with Clam AntiVirus
  26                                         [default: 0]
  27
  28 clamav_enable_arc=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_recv_infected=1                  enable to save infected messages to a
  38                                         mailfolder. If not enabled the mails
  39                                         will be deleted
  40                                         [default: 1]
  41
  42 clamav_save_folder=#mh/Mailbox/virus    the folder that should be used to save
  43                                         infected mails, if empty the default
  44                                         trash folder is used
  45                                         [default: none, use default trash]
  46
  47 Clam AntiVirus is licensed under the GPL and can be downloaded from
  48 http://clamav.sourceforge.net/