You can find our user documentation at

Check out our new API beta site!

Child pages
  • cPanel API 2 Functions - Email::tracefilter
Skip to end of metadata
Go to start of metadata


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.


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


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


In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.


 WHM API (JSON)"coffee"


 For more information, read our Calls from the WHM API documentation.

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


For more information, read our Guide to the LiveAPI System.

 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',


For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Email tracefilter filtername=coffee


  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:


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


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


ParameterTypeDescriptionPossible valuesExample

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.


The filter name.

The name of a filter on the account.



ReturnTypeDescriptionPossible valuesExample
tracestringA series of messages that describe the trace results.

A series of strings.


This output may contain HTML. 

 Click to view...
Warning: no message headers read\nReturn-path copied from sender\nSender      =\nRecipient   =\nTesting Exim filter file &quot;/etc/vfilters/;\n\nFiltering did not set up a significant delivery.\n<b>Normal delivery will occur.\n</b>

A reason for failure.


This function only returns a reason value if it failed. 

A string that describes the error.

This is an error message.

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.