# cPanel API 2 Functions - Email::listforwards 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 list a domain's forwarders. Warning: We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function: - ` Email::list_forwarders ` — This function lists a domain's forwarders. 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=listforwards&domain="example.com"®ex="user" ``` 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 forwards that contain "user" on example.com. $list_forwarders = $cpanel->api2( 'Email', 'listforwards', array( 'domain' => 'example.com', 'regex' => 'user', ) ); ``` 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 forwards that contain "user" on example.com. my $list_forwarders = $cpliveapi->api2( 'Email', 'listforwards', { 'domain' => 'example.com', 'regex' => 'user', } ); ``` 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 listforwards domain=example.com regex=user ``` 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":{ "event":{ "result":1 }, "apiversion":2, "data":[ { "uri_dest":"mailforward%40example.com", "forward":"user@example.com", "dest":"mailforward@example.com", "html_dest":"mailforward@example.com.com", "html_forward":"user@example.com", "uri_forward":"user%40example.com" }, { "uri_dest":"forwarded%example.com", "forward":"user@example.com", "dest":"forwarded@example.com", "uri_forward":"user%40example.com", "html_forward":"user@example.com", "html_dest":"forwarded@example.com" } ], "module":"Email", "func":"listforwards" } } ``` 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 domain td em string td p The domain to search for forwarders. p If you do not specify a code domain value, the function returns forwarders for all of the cPanel account's domains. td p A valid domain on the cPanel account. td code example.com tr td code regex td em string td p A a Perl Compatible Regular Expression (PCRE) that filters the results. p The system matches the PCRE to both the email address's username and domain. td A valid PCRE. td code user br ## Returns table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code html_dest td em string td The address to which the system forwards mail, or the method that the system uses to handle mail, in an HTML-safe format. td ul li An email address, in an HTML-safe format — The system forwards mail to this address. li code :fail: — The system bounces mail back to the sender, and sends a failure message. li code :blackhole: — The system deletes mail without a failure message. li The path to an application, in an HTML-safe format — The system pipes mail to this application. li A username, in an HTML-safe format — The system forwards mail to this system account. td code mailforward@example.com tr td code dest td em string td The address to which the system forwards mail, or the method that the system uses to handle mail, in plaintext. td ul li An email address, in plaintext format — The system forwards mail to this address. li code :fail: — The system bounces mail back to the sender, and sends a failure message. li code :blackhole: — The system deletes mail without a failure message. li The path to an application, in plaintext format — The system pipes mail to this application. li A username, in plaintext format — The system forwards mail to this system account. td code mailforward@example.com tr td code html_forward td em string td p The email address, in an HTML-safe format. td An email address on the cPanel account, in an HTML-safe format. td code user@example.com tr td code forward td em string td The email address, in plaintext. td An email address on the cPanel account, in plaintext. td code user@example.com tr td code uri_dest td em string td The address to which the system forwards mail, or the method that the system uses to handle mail, in URI-encoded format. td div ul li An email address, in URI-encoded format — The system forwards mail to this address. li code %3afail%3a — The system bounces mail back to the sender, and sends a failure message. li code %3ablackhole%3a — The system deletes mail without a failure message. li The path to an application, in plaintext format — The system pipes mail to this application. li p A username, in URI-encoded format — The system forwards mail to this system account. p br p div Note: br p URI-encoded email addresses replace the code @ symbol with code %40 . br td code mailforward%40example.com tr td code uri_forward td em string td The email address, in URI-encoded format. td div p An email address on the account, in URI-encoded format. td code user@example.com 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