cPanel API 1 Functions - CustInfo::getemail - Knowledgebase

Description

This function retrieves the account's contact email addresses.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — None.
cPanel API 2 — CustInfo::contactemails — This function retrieves the account's primary and secondary email addresses.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$contact_email = $cpanel->api1('CustInfo', 'getemail'); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $contact_email = $cpliveapi->api1('CustInfo', 'getemail'); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="CustInfo::getemail()">

Output (plaintext)

username@example.com

Parameters

This function does not accept parameters.

Returns

This function returns the email address or addresses that the ~/.contactemail file contains.

Knowledgebase

Categories

Categories