# cPanel API 2 Functions - CustInfo::contactemails 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 the account's primary and secondary email addresses. Warning: We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists. Note: You can **only** execute this function if your hosting provider enables the following features in WHM's *[Feature Manager](https://docs.cpanel.net/whm/packages/feature-manager/)* interface (*WHM >> Home >> Features >> Feature Manager*). - The *Contact Information* feature. - The *Update Notification Preferences* feature. ## Examples WHM API (JSON) ```undefined syntaxhighlighter-pre https://hostname.example.com:2083/cpsess##########/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=CustInfo&cpanel_jsonapi_func=contactemails&username=example1%40example.com ``` Note: For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. LiveAPI PHP Class ```undefined syntaxhighlighter-pre $cpanel = new CPANEL(); // Connect to cPanel - only do this once. // Retrieve the primary and secondary email contacts. $save_contact = $cpanel->api2( 'CustInfo', 'contactemails', array( username => 'example1@example.com', ) ); ``` Note: For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). LiveAPI Perl Module ```undefined syntaxhighlighter-pre my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once. # Retrieve the primary and secondary email contacts. my $save_contact = $cpliveapi->api2( 'CustInfo', 'contactemails', { username => 'example1@example.com', } ); ``` Note: For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). cPanel Tag System (deprecated) Warnings: - 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. Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username CustInfo contactemails username=example1@example.com ``` div Notes: - You **must** URI-encode values. - `username` represents your account-level username. - You **must** include the `--user=username` option. - 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": "contactemails", "apiversion": 2, "data": [{ "descp": "The system sends account notifications and password reset confirmations to this email address. Do not use an email address owned by your cPanel account.", "value": "bob@example2.com", "enabled": 1, "name": "email", "type": "string" }, { "enabled": 1, "descp": "Enter a second email address to receive account notifications and password reset confirmations.", "value": "", "type": "string", "name": "second_email" }, { "type": "string", "name": "pushbullet_access_token", "enabled": 1, "descp": "An access token for Pushbullet.", "value": "a1b2c3d4e5f6g7h8i9j0" }], "module": "CustInfo", "event": { "result": 1 } } } ``` Note: 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. ## Parameters table thead tr th Parameter th Type th Description th Possible values th Example tbody tr td code username td em string td p The Subaccount in which to load the contact information. ul li We added this parameter in cPanel & WHM version 56. li If you set the code username parameter, the function strong only returns the Subaccount's contact information. td p A valid Subaccount the that authenticated cPanel account user owns. td code example1@example.com ### Returns table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code enabled td em Boolean td Whether the notification setting is enabled. td ul li code 1 — Enabled. li code 0 — Disabled. td code 1 tr td code value td em string td The notification setting's value. td A valid email address. td code user@example.com tr td code type td em string td The notification setting's data type. td ul li code string li code Boolean td code string tr td code descp td em string td The notification setting's description. td A valid string. td p code This is an email address at which the system can contact you. This should be an email address that is not on your account. tr td code name td em string td The notification setting's name. td ul li code email li code second_email li code pushbullet_access_token td code email tr td code reason td em string td div p A reason for failure. p This function only returns a code reason value if it failed. 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 — Success. li code 0 — Failure. td code 1