# cPanel API 2 Functions - Email::loadfilter 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 retrieves an email filter's information. 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::get_filter ` — This function retrieves an email filter's information. 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=loadfilter&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. // List information for the "coffee" mail filter. $filter_info = $cpanel->api2( 'Email', 'loadfilter', 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. # List information for the "coffee" mail filter. my $filter_info = $cpliveapi->api2( 'Email', 'loadfilter', { '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 loadfilter 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": "loadfilter", "data": [ { "filtername": "coffee", "actions": [ { "dest": "/dev/null", "number": 1, "action": "save" } ], "rules": [ { "number": 1, "match": "is", "part": "$header_from:", "opt": "or", "val": "user@example.com" } ] } ], "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 thead tr th strong Parameter th strong Type th strong Description th strong Possible values th strong Example tbody tr td code filtername td em string td p strong Required p The filter's name. td A string value. td code coffee tr td code account td em string td p The cPanel account name or email address, to retrieve a user-level filter. p If you do not use this parameter, the function retrieves an account-level filter. td ul li The cPanel username. li A user-level filter's email address. td code user ## Returns table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code filtername td em string td The filter name. td A string value. td code coffee tr td code actions td em array of hashes td An array of hashes of the filter's actions. td p Each hash includes the code dest , code number , and code action returns. td br tr td p code dest td em string td p The destination to which the filter sends mail. p The function returns this value in the code actions hash. td ul li A file path. li An application path. li A valid email address. td code filteredmsgs@example.com tr td p code number td em integer td p The rule's order in the list. p The function returns this value in the code actions hash. td p A positive integer that represents the rule's order in the filter. p For example, the filter's first rule returns code 1 . td code 1 tr td p code action td em string td p The filter's action. p The function returns this value in the code actions hash. td ul li code deliver — The filter sends mail to the code dest address. li code fail — The filter forces a delivery failure. li code finish — The filter stops message processing. li code save — The filter saves mail to the code dest file. li code pipe — The filter sends mail to the code dest application. td code deliver tr td code rules td em array of hashes td An array of hashes of the filter's rules. td Each hash includes the code number , code match , code part , code opt , and code val returns. td br tr td p code number td em integer td p The rule's order in the list. p The function returns this value in the code rules hash. td p A positive integer that represents the rule's order in the filter. p For example, the filter's first rule returns code 1 . td code 1 tr td p code match td em string td p The filter's match type. p The function returns this value in the code rules hash. td ul li code is li code matches li code contains li code does not contain li code begins li code does not begin li code ends li code does not end li code does not match li code is above li code is not above li code is below li code is not below td code contains tr td p code part td em string td p The queried email section. p The function returns this value in the code rules hash. td ul li code $header_from: — Matches against the code From: section. li code $header_subject: — Matches against the code Subject: section. li code $header_to: — Matches against the code To: section. li code $reply_address: — Matches against the code Reply To: section. li code $message_body — Matches against the message's body. li code $message_headers — Matches against the message's headers. li code foranyaddress $h_to:,$h_cc:,$h_bcc: — Matches against all message recipients. li code not delivered — Matches if the message is not queued for delivery. li code error_message — Matches if the incoming message bounced. td code $message_body tr td p code opt td em string td p The connection between multiple conditions. p The function returns this value in the code rules hash. td ul li code and — Match both conditions. li code or — Match either condition. li code null — Only strong one condition exists. td code and tr td p code val td em string td p The matched value. p The function returns this value in the code rules hash. td A string value. td code coconut 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