cPanel API 2 Functions - Email::tracefilter - Knowledgebase

Description

This function tests mail filters. The function only tests filters for the cPanel account's main domain, and only tests against the message's body.

For more information about Exim filters, read Exim's documentation.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Email::trace_filter — This function tests mail filters.

Note:

In cPanel & WHM version 11.50 and later, if the domain or account does not contain a filter file, this function will fail.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=tracefilter&filtername=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Test a filter.
$test_filter = $cpanel->api2(
    'Email', 'tracefilter', 
    array(
        'filtername'      => 'coffee',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Test an email filter.
my $test_filter = $cpliveapi->api2(
    'Email', 'tracefilter',
    {
        'filtername'      => 'coffee',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "tracefilter",
    "data": [
      {
        "trace": "Warning: no message headers read\nReturn-path copied from sender\nSender      = user@example.com\nRecipient   = user@example.com\nTesting Exim filter file &quot;\/etc\/vfilters\/example.com&quot;\n\nFiltering set up at least one significant delivery.\n<b>No other deliveries will occur.\n<\/b>"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
account	string	The cPanel account name or email address, to test a user-level filter. If you do not use this parameter, the function tests an account-level filter.	The cPanel username. A user-level filter's email address.	user
filtername	string	Required The filter name.	The name of a filter on the account.	coffee

Parameter

Type

Description

Possible values

Example

account

string

The cPanel account name or email address, to test a user-level filter.

If you do not use this parameter, the function tests an account-level filter.

The cPanel username.
A user-level filter's email address.

user

filtername

string

Required

The filter name.

The name of a filter on the account.

coffee

Returns

Return	Type	Description	Possible values	Example
trace	string	A series of messages that describe the trace results.	A series of strings. Note: This output may contain HTML.
reason	string	A reason for failure. Note: This function only returns a reasonvalue if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories