##
## 2008 (c) Cloudmark, Inc. All rights reserved.
##----------------------------------------------------------------------------
## Cartridge Configuration File
##
## This configuration file defines the settings and preferences for
##  SpamDNA cartridge micro-updates.  Lines whose first non-whitespace
##  character is a '#' are ignored.
##----------------------------------------------------------------------------


## CONFIGURATION OPTIONS
##---------------------------------------------------------------------------

## KEY: micro-update hostname      (Fully Qualified Domain Name or IP Address)
##
##      The host providing SpamDNA cartridge micro-updates.
##
##      Warning: if you change this hostname, you must clear the
##          .../etc/<micro-update cache path>/micro_updates
##          directory at the same time. Failure to do so may result
##          in degraded accuracy.
##
## Default:
##          micro-update hostname = microupdates.cloudmark.com
micro-update hostname = microupdates.cloudmark.com


## KEY: micro-update port      (port number)
##
##      The port number of the micro-update server to connect to.
##
##      Warning: Cloudmark's micro-update servers only listen on port 80 and
##               25, so setting this value to arbitrary ports will
##               typically not work.
##
## Default:
##      micro-update port = 80


## KEY: local address for m-u conns (Fully Qualified IP Address)
##
##      An address to bind sockets to when connecting to the configured
##         micro-updates host or http proxy.
##
## Default:
##          None (will bind sockets to an arbitrary available address)
##          local address for m-u conns = 127.0.0.1

## KEY: micro-update cache path    (Absolute or relative path to directory)
##
##      The micro-update disk cache, by default, appears within the product
##      configuration directory.  An alternate location may be specified by
##      setting the 'micro-update cache path' parameter.
##
##      By default, the path is taken to be relative to the product's
##      '.../etc' configuration directory.  On UNIX systems, if the parameter
##      value begins with '/', then this value specifies the absolute path of
##      the disk cache.  On Windows systems, please use the standard drive
##      letter prefix to specify an absolute path (ex: 'C:\')
##
## Default:
##          micro-update cache path = .


## KEY: micro-update interval      (integer number of hours or "auto")
##
##      Time between downloads of the SpamDNA cartridge micro-updates in
##      hours.  The recommended value is "auto" which provides a good
##      balance between update frequency and bandwidth usage.
##
## Default:
##          micro-update interval = auto
micro-update interval = auto


## KEY: micro-update timeout       (integer number of seconds)
##
##      Number of seconds that any network operation may take before timing
##      out.
##
## Default:
##          micro-update timeout = 60
micro-update timeout = 60


## KEY: micro-update short end to end timeout       (integer number of seconds)
##
##      Number of seconds that an entire HTTP download may take for
##      operations that typically do not take a long time.  The operation
##      will time out "micro-update short end to end timeout" seconds
##      after it was started.
##      Tune this parameter based of the speed on your internet connection.
##      If this timeout is too short, the cartridge may never manage to
##      download an incremental micro-update file in full.
##
## Default:
##          micro-update short end to end timeout = 300


## KEY: micro-update end to end timeout       (integer number of seconds)
##
##      Number of seconds that an entire HTTP download may take for
##      operations that usually take a longer amount of time.  The download
##      will time out "micro-update end to end timeout" seconds after it
##      was started.
##      Tune this parameter based of the speed on your internet connection.
##      If this timeout is too short, the cartridge may never manage to
##      download a complete micro-update file in full.
##
## Default:
##          micro-update end to end timeout = 3600


## KEY: enable micro-updates       ("yes" or "no")
##
##      Set to "yes" to enable SpamDNA cartridge micro-updates. Set to "no"
##      to disable SpamDNA cartridge micro-updates.
##
## Default:
##          enable micro-updates = yes
enable micro-updates = yes

## KEY: download micro-updates before init       ("yes" or "no")
##
##      If "yes", the cartridge will download the latest micro-updates from
##      the network as a part of cartridge initialization and will wait for
##      the download to complete before finishing initialization. If
##      "no", the cartridge will read any available micro-updates from disk
##      immediately, finish initialization, and then download the latest
##      micro-updates from the network in the background.
##
##      NOTE: It is strongly recommended that you change this setting to
##            "yes". This ensures that on startup the cartridge has the
##            most up-to-date micro-update files available.
##
## Default:
##          download micro-updates before init = no
download micro-updates before init = no


## KEY: consider empty messages spam  ("yes" or "no")
##
##      By default, this cartridge will treat "empty" messages as
##      legitimate. A message is "empty" if its subject and body are both
##      empty or consist only of whitespace. If you wish to treat empty
##      messages as spam, uncomment the following line and change the value
##      to "yes".
##
## Default:
##          consider empty messages spam = no


## KEY: http proxy                 (address:port or hostname:port)
##
##      If you want to use a http proxy for network connections,
##      specify it here, in the form host:port or addr:port
##
## Default:
##          <N/A>
## Example:
##          http proxy = localhost:8800


## KEY: http proxy basic auth      (user:password)
##
##      The cartridge supports optional http basic authentication for
##      connections to proxies. If your proxy requires basic
##      authentication, enter a username:password here.
##
## Default:
##          <N/A>
## Example:
##          http proxy basic auth = user:password


## KEY: http proxy ntlm auth      (user:password)
##
##      The cartridge supports optional http ntlm authentication for
##      connections to proxies. If your proxy requires ntlm
##      authentication, enter a domain:username:password here.
##
## Default:
##          <N/A>
## Example:
##          http proxy ntlm auth = domain:user:password


## KEY: report statistics          ("yes" or "no")
##
##      Report statistics to Cloudmark
##      Set to "yes" to enable sending of basic message scanning statistics
##      to Cloudmark. No message content or user information will be sent
##      using this feature. Enabling statistics will help Cloudmark to
##      pro-actively track issues with spam filtering accuracy and quality
##      of service. Cloudmark will use this information to notify you of
##      any issues and resolve them quickly.
##
## Default:
##          report statistics = yes

## KEY: exclude from stats reports (item1,item2,...)
##
##      For privacy reasons, you can choose to exclude certain items
##      from statistics reports. These items include:
##          "whitelist":   the contents of whitelist.cfg
##          "proxy auth":  http proxy authentication credentials
##
##      However, it is strongly recommended that you include these items in
##      statistics reports as they will significantly aid in diagnosis
##      of configuration and accuracy problems.
##
##      To exclude these items from statistics reports, add any of the
##      above keywords to this configuration option, separated by ','
##      characters.
##
## Default:
##          exclude from stats reports =
## Example:
##          exclude from stats reports = whitelist,proxy auth

## KEY: customer id                (email address)
##
##      If you have a Cloudmark Network Feedback System logon account,
##      please enter your CNFS logon name here.  This information will
##      be used to correlate message scanning statistics with your
##      CNFS account if you have enabled statistics reporting using the
##      'report statistics' configuration setting. If you do not use CNFS
##      to report feedback to Cloudmark, but would still like to report
##      statistics, please enter an identifier for your company here.
##      If your installation has multiple filtering servers, this identifier
##      should be identical across all filtering servers.
##
##      The address should be in the form companyname@feedback.cloudmark.com
##
## Default:
##          <N/A>
## Example:
##          customer id = companyname@feedback.cloudmark.com
customer id = communigate-customername@feedback.cloudmark.com

## KEY: favor analysis over speed ("yes" or "no")
##
##      By default, the cartridge stops classification as soon as it knows
##      the final score for a message. For example, if a whitelist entry in
##      whitelist.cfg matches the message, all scoring stops and a score of 0
##      is returned. Similarly, if a fingerprinting scheme assigns a score of
##      100 to a message, subsequent fingerprinting schemes are skipped.
##
##      However, this may prevent the cartridge from returning complete
##      category, sub-category, rescan, or message analysis information, as
##      skipped fingerprinting algorithms may have changed the category for a
##      message, indicated that a message could be scanned later, etc. If your
##      application wishes to trade off complete analysis information for
##      classification time, set this option to "yes". The default option is
##      "no", i.e. stop scoring when the final score for a message is known.
##
## Default:
##          favor analysis over speed = no
favor analysis over speed = no

## KEY: use ip information ( "yes" or "no")
##
##      The cartridge can optionally use connection-level information such
##      as the IP addresses of email senders when classifying messages.
##      If you do not wish to use this additional information, set this
##      option to no. By default, connection-level information is used.
##
##      The advantage of using connection-level information is increased
##      accuracy in cases where other fingerprinting schemes are not able to
##      extract meaningful content from a message. However, when enabled all
##      messages from a spammy IP address will be marked as spam.
##
##      If this option is set to yes, it is *highly* recommended that
##      you also set the related option "gateway received hosts" to
##      give the cartridge information on your internal mail routing
##      topology.
##
##      When the cartridge is loaded by applications that use CMAE
##      3.0 or later, this option is ignored. In CMAE 3.0, the choice to score
##      senders in addition to, or instead of, content is handled via alternate
##      scoring APIs that can be called on a message-by-message basis instead
##      of a global configuration option.
##
## Default:
##          use ip information = yes

## KEY: use envelope for ip information ("yes" or "no")
##
##      When this option is set to "yes" (and when "use ip information"
##      is set to "yes"), instead of examining Received: headers to determine
##      the sending IP, envelope information is used instead (specifically,
##      the FromIP component of the CMAE_Envelope structure passed to
##      CMAE_Score). If the envelope IP is found in micro-update files,
##      it is used as the sending IP. Otherwise, the Received: headers are
##      examined to find the sending IP.
##
##      This is useful in cases where SpamDNA scores a message
##      before the Received: header that reflects the hop into the MTA has
##      been added to the message.
##
## Default: no (i.e. Received: headers are used)
##          use envelope for ip information = no

## KEY: gateway received hosts (hostname/address 1,hostname/address 2,...)
##
##      When using connection level information to classify messages,
##      these hostnames will be considered the set of "edge"
##      MTAs. Specify a list of hostnames *exactly* as they appear in
##      Received: headers, separated by ',' characters. If not
##      specified, the cartridge will use a set of heuristics to
##      determine the edge MTA from a collection of Received: headers.
##
##      NOTE: It is *very* important that this option is set properly. If
##            set incorrectly, it is possible that every incoming message
##            will be classified as spam! Make sure this set of hosts
##            completely and accurately describes your set of external-facing
##            MTAs.
##
## Default: none (heuristics are used)
##          gateway received hosts =

## KEY: image processing depth ("none", "low", "medium", "high")
##
##      When processing images, the cartridge may use a variety of
##      methods to compute fingerprints, and some methods are more
##      resource intensive than others. This option allows you to
##      control which fingerprinting methods are run on images. For a
##      value of C, fingerprinting methods with cost <= C will be
##      run. For example, if "image processing depth" is set to
##      "medium", low and medium cost fingerprinting methods will
##      run and high cost fingerprinting methods will be skipped.
##
##      The default value of "high" instructs the cartridge to run
##      all image fingerprinting methods, achieving the highest
##      accuracy as a result.
##
##      If you set this value to "none", no image-specific
##      fingerprinting schemes will run. (Other content-agnostic
##      fingerprinting schemes will still run on images,
##      however.)
##
##      NOTE: accuracy will be significantly affected if this option is
##      changed from its default value. You should only change it if
##      your installation processes very high message volumes and you
##      observe excessive CPU load while processing messages
##      containing image attachments.
##
## Default:
##         image processing depth = high


## KEY: enable ip statistics ("yes" or "no")
##
##
##      When this option is set to "yes", the cartridge will report to
##      Cloudmark the IP address of message senders (MTAs) in statistics
##      reports.
##
## Default:
##         enable ip statistics = no


## KEY: enable fingerprint tracking ("yes" or "no")
##
##      When this option is set to "yes", the cartridge will report
##      to Cloudmark the fingerprints that the cartridge generates.
##
## Default:
##         enable fingerprint tracking = no


## KEY: max tracking post size bytes (integer greater or equal to 10000)
##
##      Limit on the maximum size of a POST HTTP request for
##      fingerprint tracking.
##      Set this value lower if HTTP error 413 appears in the logs.
##
## Default:
##      max tracking post size bytes = 1000000


## KEY: max tracking bandwidth megabits (float greater than or equal to 0.01)
##
##      Maximum bandwidth to be used by the fingerprint tracking feature.
##      The value is a float that is a number of megabits.
##
## Default:
##      max tracking bandwidth megabits = 1.0


## KEY: af maximum message number      (integer number of messages)
##
##      Sets maximum number of messages that will be stored in Active Filter.
##      When maximum number is surpassed, messages are cleaned out on an
##      oldest removed first basis.
##
## Default:
##      af maximum message number = 100000

## KEY: af message age limit       (integer number of seconds)
##
##      Sets maximum age for messages stored in Active Filter in seconds.
##      Any message older than this limit will be removed.
##
## Default:
##       af message age limit = 10800

## KEY: enable quickstart	("yes" or "no")
##
##      Saves a subset of signatures to disk in a quick loading format and
##      use that subset to score until the full set has loaded at startup.
##
## Default:
##       enable quickstart = no

## KEY: quickstart dump interval	(integer number of seconds)
##
##      Specifies the time interval at which the quickstart
##      signature subset is saved to disk.
##
##      NOTE: This value can not be less than the
##      pico-update interval seconds value (default 60 seconds),
##      if provided.
##
## Default:
##       quickstart dump interval = 3600