This function retrieves the account's primary and secondary email addresses.
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.com
LiveAPI PHP Class
$cpanel = new CPANEL();
$save_contact = $cpanel->api2(
'CustInfo', 'contactemails',
array(
username => 'example1@example.com',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $save_contact = $cpliveapi->api2(
'CustInfo', 'contactemails',
{
username => 'example1@example.com',
}
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Command Line
cpapi2 --user=username CustInfo contactemails username=example1@example.com
|
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
}
}
}
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
username
|
string
|
The Subaccount in which to load the contact information.
Note:
- We added this parameter in cPanel & WHM version 56.
- If you set the usernameparameter, the function only returns the Subaccount's 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 — Enabled.
- 0 — Disabled.
|
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.
Note:
This function only returns a reasonvalue if it failed.
|
A string that describes the error.
|
This is an error message.
|
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — Success.
- 0 — Failure.
|
1
|
