Function __global->check_rbl
Definitions
sources/antispam.php
- Do an RBL check on an IP address.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $rbl | ID_TEXT | No | No | required parameter | N/A | N/A | The RBL domain name/IP (HTTP:BL has a special syntax) |
| $user_ip | IP | No | No | required parameter | N/A | N/A | The IP address to lookup |
| $we_have_a_result_already | boolean | No | No | False | N/A | N/A | If true, then no RBL check will happen if the RBL has no scoring, because it can't provide a superior result to what is already known (performance) |
| $page_level | boolean | No | No | False | N/A | N/A | Whether this is a page level check (i.e. we won't consider blocks or approval, just ban setting) |
Returns
- Pair: Listed for potential blocking as a ANTISPAM_RESPONSE_* constant, confidence level if attainable (0.0 to 1.0) (else null)
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Do an RBL check on an IP address.
*
* @param ID_TEXT $rbl The RBL domain name/IP (HTTP:BL has a special syntax)
* @param IP $user_ip The IP address to lookup
* @param boolean $we_have_a_result_already If true, then no RBL check will happen if the RBL has no scoring, because it can't provide a superior result to what is already known (performance)
* @param boolean $page_level Whether this is a page level check (i.e. we won't consider blocks or approval, just ban setting)
* @return array Pair: Listed for potential blocking as a ANTISPAM_RESPONSE_* constant, confidence level if attainable (0.0 to 1.0) (else null)
*/
function check_rbl(string $rbl, string $user_ip, bool $we_have_a_result_already = false, bool $page_level = false) : array
* Do an RBL check on an IP address.
*
* @param ID_TEXT $rbl The RBL domain name/IP (HTTP:BL has a special syntax)
* @param IP $user_ip The IP address to lookup
* @param boolean $we_have_a_result_already If true, then no RBL check will happen if the RBL has no scoring, because it can't provide a superior result to what is already known (performance)
* @param boolean $page_level Whether this is a page level check (i.e. we won't consider blocks or approval, just ban setting)
* @return array Pair: Listed for potential blocking as a ANTISPAM_RESPONSE_* constant, confidence level if attainable (0.0 to 1.0) (else null)
*/
function check_rbl(string $rbl, string $user_ip, bool $we_have_a_result_already = false, bool $page_level = false) : array
