Core Attributes

core.compile
If true, calling scan_message() causes the engine to automatically compile the anti-spam data in the directory specified by core.datadir . Failures are ignored internally.

Type: PMX_TYPE_INTEGER

Default: 1

core.datadir
This attribute specifies the location (for example, ../datadir) of data files that the anti-spam engine uses.
Important
This is a required attribute.

Type: PMX_TYPE_STRING

Default: None

core.data-version
This attribute returns the version of the anti-spam data that the engine currently uses. If the data version cannot be determined, <unknown> is returned. If the engine has been loaded but load_antispam_data() has not been called, the core.data-version attribute is not defined. If the anti-spam data is loaded, it returns a string containing the data version.

Type: PMX_TYPE_STRING

Default: none

core.event.fur
This attribute must be specified and set to "1" in order for the PMX_EV_FUR event code to be reported to the PMX_SCAN_CB callback. For information about PMX_EV_FUR, see "Event Codes" in the Anti-Spam Engine Reference section.

The discovery of first untrusted relays will vary depending on whether and how you have configured the plugin.net.trusted.relays attribute. For more information, see "net Attributes" in the Anti-Spam Engine Attributes section.

See also: plugin.net.trusted-relays under "net Attributes" in the Anti-Spam Engine Attributes section.

Type: PMX_TYPE_INTEGER

Default: 0

core.local-tests-only
If true, plug-ins that would normally connect to the internet to perform tests will skip such tests.

Type: PMX_TYPE_INTEGER

Default: 0

core.max-bytes-scanned
The maximum number of bytes the engine processes per message part. Regardless of the overall message size and the number of bytes sent to the engine, only the number of bytes specified in this attribute are scanned, which provides a predictable processing time. This attribute only limits CPU usage during scanning; entire messages (or the parts of messages sent to the engine) are stored in memory.

Type: PMX_TYPE_INTEGER

Default: 10240

core.schema-version
This attribute returns the data schema version for the current anti-spam engine.

Type: PMX_TYPE_STRING

Default: None

core.statistics-directory
Specifies a directory into which the engine statistics will be written. This same directory must be specified to the feedback tool when it is used to upload statistics to Sophos. Note that if this directory is not specified, then the engine statistics will be written to the 'stats' subdirectory of the location specified by the core.datadir attribute.

Type: PMX_TYPE_STRING

Default: none

core.stop-scan
If true, the engine stops scanning once a message is definitively determined to be either spam or not spam (that is, has a very high positive or negative spam score). The resulting cumulative spam score may differ from the results of a full scan. Excluded rules will not appear in anti-spam reports and headers.

Type: PMX_TYPE_INTEGER

Default: 0

core.version
This attribute returns the version of the current anti-spam engine.

Type: PMX_TYPE_STRING

Default: None