Description

This function retrieves the account's primary and secondary email addresses.

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.


Examples 




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



$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',
	)
);

 



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',
	}
);

 




cpapi2 --user=username CustInfo contactemails username=example1@example.com



 {
	"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
		}
	}
}



Parameters

ParameterTypeDescriptionPossible valuesExample
usernamestring

The Subaccount in which to load the contact information.

  • We added this parameter in cPanel & WHM version 56.
  • If you set the username parameter, the function only returns the Subaccount's contact information.


A valid Subaccount the that authenticated cPanel account user owns.

example1@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
enabledBooleanWhether the notification setting is enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1
valuestringThe notification setting's value.A valid email address.user@example.com
typestringThe notification setting's data type.
  • string
  • Boolean
string
descpstringThe notification setting's description.A valid string.


 This is an email address at which the system can contact you. This should be an email address that is not on your account.


namestringThe notification setting's name.
  • email
  • second_email
  • pushbullet_access_token
email
reasonstring

A reason for failure.

This function only returns a reason value if it failed.


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — Success.
  • 0 — Failure.
1