INSTALLATION

    To install the ASSP_SNF.pm plugin, simply drop it in your Plugins 
directory and restart ASSP. 

DETAILS

    This plugin requires ASSP 2.0 or higher. (As of this writing ASSP 2.0 
is still in beta test.) ASSP 2.0 requires perl 5.8.8 and so does this plugin.
This plugin also uses the following perl modules:

    IO::File
    IO::Socket
    Time::HiRes

    All of those modules are included in a standard perl 5.8.8 installation, 
so you shouldn't have to worry about installing them. 

    This plugin communicates with the SNF Server over TCP. It uses a 
temporary file to pass an email message to the SNF Server. The temporary file
must be in a directory that both the SNF Server and the ASSP process can read,
write, and create files in. On *nix systems this can be accomplished by
creating a directory (e.g., /opt/snf/tempdir) and setting its ownership to
"snfilter:snfilter" and its permissions to 777:

    $ mkdir /opt/snf/tempdir
    $ chown snfilter:snfilter /opt/snf/tempdir
    $ chmod 777 /opt/snf/tempdir

    It is strongly recommended that you create a directory specifically for 
this purpose. The default value for this directory is:

    /opt/snf/tempdir        - *nix
    C:\SNFTEMP              - Windows

    Your SNF Server should be set to operate in "api" mode. (Note: This is 
not the default mode.) This reduces I/O by preventing the SNF Server from
re-writing the temporary message files. Set the output mode in your
snf_engine.xml file, in the <xheaders> container like this:

    <xheaders>
        <output mode='api'/>
        ...


CONFIGURATION

    The ASSP_SNF plugin provides a configuration pane in the ASSP 
web-based configuration panel. Click on ASSP_SNF-Plugin in the menu and the
plugin configuration pane will open. In addition to the standard ASSP plugin
configuration options the following SNF-specific options are configurable in
this panel:

    SNF Server hostname (ASSP_SNF_Host)

    The hostname is used to connect to the SNF Server. Usually localhost, but
    may be different if your SNF Server is running on a different host than
    this ASSP installation.

    SNF Server port number (ASSP_SNF_Port)

    The port number is used to connect to the SNF Server. The default value is
    often correct, unless you've intentionally changed it in your SNF
    configuration.

    SNF Server connection timeout (seconds) (ASSP_SNF_Timeout)

    The timeout value is the number of seconds to wait for a connection from
    the SNF Server. The default should be fine in most cases.

    SNF Server port number (ASSP_SNF_Tempdir)

    The temporary directory used to pass mail messages to and from the SNF
    Server. This directory must be writable and readable by both the SNF
    Server and the ASSP installation.

    Maximum temporary file size (ASSP_SNF_MaxTempFileSize)
    
    The maximum size that will be written for a temporary mail message file.
    The default (64k) matches the size used by the SNF Server. So there
    shouldn't be much cause to change it.

    SNF code spam threshold (ASSP_SNF_Threshold)
    
    The SNF result code threshold that is considered spam. SNF result codes at
    this level or above will be considered spam for the purposes of ASSP
    scoring. The default value of 20 is good in most cases.