DragonFly On-Line Manual Pages

CLAMCOUR(1)                        Man Pages                       CLAMCOUR(1)

NAME
       clamcour - Courier filter for ClamAV to scan incoming mail for viruses

SYNOPSIS
       filterctl [ start | stop ] clamcour

DESCRIPTION
       This manual page briefly documents ClamCour which is a a Courier filter
       for ClamAV to allow the scanning of incoming mail. In case a virus is
       found, the mail is rejected. Optionally A MIME-header that reports
       ClamCour signature is added, a customizable message to recipients can
       be sent and message can be copied into "quarantine" zone for later
       check.

       Use "filterctl [ start | stop ] clamcour" to activate/deactivate the
       ClamCour filter.

       For more info on how Courier's courierfilter and filterctl works, see
       courierfilter(8) or visit
       <http://www.courier-mta.org/?courierfilter.html>

CONFIGURATION FILES
       ClamCour uses four configuration files which are located in
       /COURIER_ETC/clamcour (where CLAMCOUR_ETC is Courier's etc directory).
       These configuration files are plain text files that can be modified
       with any text editor.  You must run courier restart for any changes to
       these files to take effect.

       quarantine
              This file contains one line, containing "quarantine zone" path.
              Following lines will be ignored. If path is not valid,
              quarantine will be disabled. Please make sure that courier's
              user has write and execute rights on the folder. Files will be
              stored like YYYYNNAAHHMMSS-DXXXXXX, where XXXXXX is a 6-digit
              number supplied by Courier, YYYYNNAAHHMMSS is the current time
              of the message, written as year, month, day, hour, minutes and
              seconds.

       bz2_compression
              When this empty file is present, infected message will be
              compressed before quarantine, using BZip2 compression.

       gz_compression
              When this empty file is present, infected message will be
              compressed before quarantine, using GZip compression. If
              bz2_compression is also present, BZip2 will be used.

       virmessage
              This file contains multiple lines, that define message's format
              for destination recipients. First two lines are sender email
              address and email subject. When a viral attachment is detected,
              destination recipients will be notified of missing email. There
              are no limitations in message text, and four tags can be used,
              that will be replaced with message informations. Each tag must
              be enclosed within '%' character. To write a single '%'
              character, just double it (i.e. '%%').

       sizelimit
              As default, clamcour won't scan attachments that are bigger than
              1Mb, thus avoiding timeout during receiving big messages. You
              can change the limit writing a "sizelimit" text file, and
              specifying maximum dimension in bytes. A value of "0" disables
              any size limit check.

VIRMESSAGE TAGS
       virmessage tags are:

       %host% It will be replaced with SMTP sender server information.

       %sender%
              It will be replaced with sender's email address.

       %virname%
              It will be replaced with virus signature.

       %date% It will be replaced with incoming message's date.

FIFO command pipe
       In 0.3.2 version a new feature was added, a FIFO file where you can
       remotely control ClamCour.  Just echo on it, it's located in /tmp
       directory.

       Available commands (case-sensitive):

       reloadDB
              This command refresh internal ClamAV virus database. It has to
              be called after a freshclam's successful update.  Just edit your
              freshclam.conf, and modify ( obviously uncomment :-) ) this line

              OnUpdateExecute /bin/echo reloadDB > /tmp/clamcour.fifo

              If there are some mails under scanning, database update will be
              delayed until clamcour gets idle.

AUTHOR
       ClamCour was written by Tony Sin(x) '76 <tony@becrux.com>. Web page:
       http://www.becrux.com/index.php?page=projects&name=clamcour

       Original manual page for the Debian distribution was written by
       Frederik Dannemare <frederik@dannemare.net>, for the Debian project.
       Current manual page was written by Tony Sin(x) '76 <tony@becrux.com>

Tony Sin(x) '76                November 1, 2006                    CLAMCOUR(1)