bm_scan

March 26, 2020 Contributors

Name

bm_scan — Invoke the Brightmail scanner

Synopsis

#include "modules/validate/ec_brightmail_api.h"

| int **bm_scan** ( | msg, |   |
|   | ac, |   |
|   | vctx, |   |
|   | verdict, |   |
|   | rules, |   |
|   | tracker, |   |
|   | is_default); |   |

ec_message * <var class="pdparam">msg</var>;
accept_construct * <var class="pdparam">ac</var>;
validate_context * <var class="pdparam">vctx</var>;
string * <var class="pdparam">verdict</var>;
string * <var class="pdparam">rules</var>;
string * <var class="pdparam">tracker</var>;
int * <var class="pdparam">is_default</var>;

Description

Invoke the Brightmail scanner.

Parameters

msg

The message to be scanned. For documentation of this data structure see “ec_message”

ac

The address of an “accept_construct” associated with the session.

vctx

The validation context. For documentation of this data structure see “validate_context”.

verdict

The verdict from the scan.

rules

The rules used to judge the mail.

tracker

A string can be used as a header in the email.

is_default

*is_default is 1 if the final destination is the default destination.

Return Values

-1 if module is not available; -2 if called in a wrong phase; 0 if scan is already done for this mail and 1 if success.

**Configuration Change. ** This feature is available starting from Momentum 3.1.