ec_messagescope_query

March 26, 2020 Contributors

Name

ec_messagescope_query — Query for reputation record

Synopsis

#include "modules/validate/ec_messagescope.h"

| int **ec_messagescope_query** ( | listname, |   |
|   | m, |   |
|   | ac, |   |
|   | ctx, |   |
|   | ip, |   |
|   | to, |   |
|   | from, |   |
|   | error_text, |   |
|   | error_len, |   |
|   | status, |   |
|   | expiration, |   |
|   | version, |   |
|   | parameter); |   |

const char * <var class="pdparam">listname</var>;
ec_message * <var class="pdparam">m</var>;
accept_construct * <var class="pdparam">ac</var>;
validate_context * <var class="pdparam">ctx</var>;
const char * <var class="pdparam">ip</var>;
const char * <var class="pdparam">to</var>;
const char * <var class="pdparam">from</var>;
char * <var class="pdparam">error_text</var>;
int <var class="pdparam">error_len</var>;
char ** <var class="pdparam">status</var>;
char ** <var class="pdparam">expiration</var>;
char ** <var class="pdparam">version</var>;
char ** <var class="pdparam">parameter</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

Query for reputation record.

Caller must provide a list name plus supplemental information. Depending on type of the list, additional inputs besides list name are needed: type = IP — ac/ip is needed. Here ac/ip means with ac or IP. type = IP:recip — (ac, m)/(ip,to) are needed. type = Envelope — m/(to,from) are needed.

Parameters

listname
  • name of the list to be queried.
m
  • message.
ac
  • accept construct.
ctx
  • validation context.
ip
  • IP address. Supplemental information for the look up.
to
  • rcptto, envelop information.
from
  • mailfrom, envelop informatin.
ntries
  • this is (ntries)th attempt for the case of return status = 0 (i.e. not ready yet).
wait_interval
  • in case of return status = 0, please wait this mount of seconds before trying again.
error_text
  • error text. Should be consulted only if return status is -1.
error_len
  • buffer length of error_text.
status
  • query status: miss, error, hit.
expiration
  • expiration time in string format.
version
  • version.
parameter
  • parameter.

Return Values

-1 for error; 0 for not ready (please try again); 1 for result is returned.

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