msys.commtouch.diagnose

March 26, 2020 Contributors

Name

msys.commtouch.diagnose — Scan messages using Commtouch

Synopsis

msys.commtouch.diagnose(msg, accept, vctx);

msg: userdata, ec_message type, optional
accept: userdata, accept_construct type, optional
vctx: userdata, validate_context type, optional

Description

This function provides diagnosis of a message’s virus or spam status. You must load and correctly configure the commtouch_ctasd module before using this function. For details, see “commtouch_ctasd – Commtouch Spam Protection”.

It can be invoked at the data, spool, or each_rcpt phases, and it will not work at the connect, ehlo, mailfrom, or rcptto phases.

Enable this function with the statement require('msys.commtouch');.

It takes the following parameters. If any of the inputs is not provided, it will be inferred from the current context:

  • msg – Email to be scored

  • accept – accept_construct

  • vctx – Validation context

This function returns a table with the following key/value pairs:

  • class – Spam classification of this message. Possible values are Unknown, Suspected, Bulk, and Spam.

  • virus-threat – Virus classification of this message. Possible values are non-virus, medium, high, and virus.

  • ref-id – Reference ID returned by the commtouch engine.

The above name value pairs are also set within the validation context with each key being prefixed with commtouch-.

Warning

Do not use pcall with this function.