# cPanel API 2 Functions - Email::listpopswithimage 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 lists the cPanel account's email addresses with `mainacct.jpg` image links. Warning: We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists. 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=listpopswithimage®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 email addresses that contain "user", with mainacct.jpg links. $list_email_addresses = $cpanel->api2( 'Email', 'listpopswithimage', array( '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 email addresses that contain "user", with mainacct.jpg links. my $list_email_addresses = $cpliveapi->api2( 'Email', 'listpopswithimage', { '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 listpopswithimage 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": { "func": "listpopswithimage", "event": { "result": 1 }, "module": "Email", "apiversion": 2, "data": [{ "email": "user@example.com", "suspended_incoming": 0, "login": "user@example.com", "suspended_login": 0 }, { "email": "username@example.com", "suspended_incoming": 0, "login": "username@example.com", "suspended_login": 0 }, { "email": "example", "login": "" }] } } ``` 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 regex td em string td p A a Perl Compatible Regular Expression (PCRE) that filters the results. The system matches the PCRE to both the email address's username and domain. p If you do not use this parameter, the function returns image links for all of the cPanel account's email addresses. td p A valid PCRE. td code user ## Returns table colgroup col col col col col thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code email td em string td The email address, or the main account username. td A valid email address, or the username for the main account. td code user@example.com tr td code login td em string td p The email address or the code Main Account string, and an HTML link to the code mainacct.jpg image. td ul li A valid email address, or the string code Main Account . li HTML code to display the account's code mainacct.jpg image. The cPanel theme that the account uses determines this image's location. td p code < img src="/frontend/cpanel-skin/images/mainacct.jpg" > tr td code suspended_incoming td em Boolean td div p Whether the email account's incoming email is suspended. td ul li code 1 — Incoming email is suspended. li code 0 — Incoming email is strong not suspended. td code 0 tr td code suspended_login td em Boolean td div p Whether the user's ability to log in to, send mail from, and read their email account is suspended. td ul li code 1 — Logins are suspended. li code 0 — Logins are strong not suspended. td code 0 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 there is an error. 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