Child pages
  • cPanel API 2 Functions - CustInfo::contactemails
Skip to end of metadata
Go to start of metadata

Description

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


Warning:

We strongly recommend that you use UAPI 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 interface (WHM >> Home >> Features >> Feature Manager).

  • The Contact Information feature.
  • The Update Notification Preferences feature.


Examples 


 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


Note:

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


Note:

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


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. 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.com


Notes:

  • 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 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /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
		}
	}
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
usernamestring

The Subaccount in which to load the contact information.

Notes:

  • 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.
 Click to view...

 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.

Note:

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