Distribution

The anti-spam engine is distributed as an archive (.zip or .tar.gz) file, located at http://pmx.sophos.com/as-sdk. You will also need to download the antispam data file (.zip or .tgz). A user account and password are required to retrieve the SDK and updates to the data files. This information will be sent by email.

Note
If you want to use the sample.c program included in the distribution, the location specified in the core.datadir attribute must match the location of the installation directory. For more information, see the "Core Attributes" section of Anti-Spam Engine Attributes.

Archive Contents

The archive contains the following directories and files. The first two files appear directly beneath the directory into which you extracted the distribution (indicated below as InstallDir).

InstallDir/bin/
Windows: pmx_engine.dll
This file (or pmx_engine.lib) must be installed on Windows systems, in a directory that is identified in the system's PATH variable.
Windows: feedback.exe
An executable used to upload engine statistics to Sophos.
Linux: feedback
An executable used to upload engine statistics to Sophos.
InstallDir/datadir/
The location where antispam data files must be installed.
InstallDir/eg/
Makefile
A file that can be used to build the samples.
README
The file describes how to use the Makefile to build sample.c.
sample.msg
A sample message used by sample.c
sample.c
A sample program that uses the .dll or .so.
InstallDir/include/
pmx_engine.h
The C header file required to use the Sophos Anti-Spam Engine.
pmx_message.h
An optional C header file that can be included to provide more control over the message object used in the Sophos Anti-Spam Engine.
InstallDir/lib/
Linux: libpmx_engine.so
The shared object for building and compiling the application in UNIX. This is a required file on UNIX systems, and it must be installed in a directory identified in the LD_LIBRARY_PATH environment variable.
Windows: pmx_engine.lib
The static library for building and compiling the application in Windows. Either this file or pmx_engine.dll is required on Windows systems.
InstallDir/MANIFEST
Contains filenames and MD5 hash space separated in one line, for example:
8e02a050d34bacb81c75d0d68191d603  pmx_engine.dll
b9d73c166f31623f5fab45c5384ef008  eg/sample.c
InstallDir/ReadMe.html
This file links to online documentation.

Antispam Data File

Extract the following two files from the antispam data file (.zip or .tgz) and install them in the datadir directory, beneath the directory into which you extracted the distribution (indicated above as InstallDir/datadir/).

asdb.antispam
This file, which is required on all systems, must be installed in the directory referenced by the core.datadir attribute.
db.summary
This file, which is required on all systems, must be installed in the directory referenced by the core.datadir attribute.