The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
This function retrieves the account's primary and secondary email addresses.
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
You can only execute this function if your hosting provider enables the following features in WHM's Feature Manager interface (WHM >> Home >> Features >> Feature Manager). - The Contact Information feature. - The Update Notification Preferences feature.
WHM API (JSON)
https://hostname.example.com:2083/cpsess##########/json-api/cpanel?cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=CustInfo&cpanel_jsonapi_func=contactemails&username=example1%40example.comFor more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
$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',
)
);For more information, read our Guide to the LiveAPI System.
LiveAPI Perl Module
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',
}
);For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI 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.
- 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 documentation.
Command Line
cpapi2 --user=username CustInfo contactemails username=example1@example.comYou must URI-encode values.
usernamerepresents your account-level username.You must include the
--user=usernameoption.For more information and additional output options, read our Guide to cPanel API 2 documentation or run the
cpapi2 --helpcommand.If you run CloudLinux™, you must use the full path of the
cpapi2command:syntaxhighlighter-pre/usr/local/cpanel/bin/cpapi2
Output (JSON)
{
"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
}
}
}Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
| Parameter | Type | Description | Possible values | Example |
|---|---|---|---|---|
username | string | The Subaccount in which to load the contact information.
| A valid Subaccount the that authenticated cPanel account user owns. | example1@example.com |
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
enabled | Boolean | Whether the notification setting is enabled. |
| 1 |
value | string | The notification setting's value. | A valid email address. | user@example.com |
type | string | The notification setting's data type. |
| string |
descp | string | The notification setting's description. | A valid string. |
|
name | string | The notification setting's name. |
| email |
reason | string | A reason for failure. This function only returns a | A string that describes the error. | This is an error message. |
result | Boolean | Whether the function succeeded. |
| 1 |