# cPanel API 2 Functions - Email::tracefilter Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## 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](/cpanel/introduction/) function instead of this function: - ` Email::trace_filter ` — This function tests mail filters. div Note: br If the domain or account does not contain a filter file, this function will fail. br div Important: br When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function. br ## Examples WHM API (JSON) ```undefined syntaxhighlighter-pre 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="coffee" ``` div Note: br For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. br LiveAPI PHP Class ```undefined syntaxhighlighter-pre $cpanel = new CPANEL(); // Connect to cPanel - only do this once. // Test a filter. $test_filter = $cpanel->api2( 'Email', 'tracefilter', array( 'filtername' => 'coffee', ) ); ``` div Note: br For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). br LiveAPI Perl Module ```undefined syntaxhighlighter-pre 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', } ); ``` div Note: br For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). br cPanel Tag System (deprecated) div Warnings: br - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system). - 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation. br Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username Email tracefilter filtername=coffee ``` div Notes: br - 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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. - If you run CloudLinux™, you **must** use the full path of the `cpapi2` command: ```undefined syntaxhighlighter-pre /usr/local/cpanel/bin/cpapi2 ``` br Output (JSON) ```undefined syntaxhighlighter-pre { "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 "/etc/vfilters/example.com"\n\nFiltering set up at least one significant delivery.\nNo other deliveries will occur.\n<\/b>" } ], "event": { "result": 1 }, "module": "Email" } } ``` div Note: br Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. br ## Parameters table colgroup col col col col col thead tr th strong Parameter th strong Type th strong Description th strong Possible values th strong Example tbody tr td code account td em string td p The cPanel account name or email address, to test a user-level filter. p If you do not use this parameter, the function tests an account-level filter. td ul li The cPanel username. li A user-level filter's email address. td code user tr td code filtername td em string td p strong Required p The filter name. td p The name of a filter on the account. td code coffee ## Returns table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code trace td em string td A series of messages that describe the trace results. td div p A series of strings. p div Note: br p This output may contain HTML. br td div code br Warning: br 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 did not set up a significant delivery.\n < b > Normal delivery will occur.\n < /b > tr td code reason td em string td div p A reason for failure. p div Note: br p This function strong only returns a code reason value if it failed. br td p A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1