cPanel API 2 Functions - Email::accountname - Knowledgebase

Description

This function retrieves an email account's username.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Email::account_name — This function returns an email account's username or address.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=accountname&account=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve the email account username for user@example.com
$get_email_username = $cpanel->api2(
    'Email', 'accountname', 
    array(
        'account'         => 'user@example.com',
    ) 
);
  
  
// Retrieve the email address for the email username "user"
$get_email_username = $cpanel->api2(
    'Email', 'accountname',
    array(
        'account'         => 'user',
    )
);
  
  
// Return "All Mail On Your Account"
$get_email_username = $cpanel->api2(
    'Email', 'accountname',
    array(
        'display'         => '',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Retrieve the email account username for user@example.com
my $get_email_username = $cpliveapi->api2(
    'Email', 'accountname',
    {
        'account'         => 'user@example.com',
    }
);
  
# Retrieve the email address for the email username "user"
my $get_email_username = $cpliveapi->api2(
    'Email', 'accountname',
    {
        'account'         => 'user',
    }
);
  
# Return "All Mail On Your Account"
my $get_email_username = $cpliveapi->api2(
    'Email', 'accountname',
    {
        'display'         => '',
    }
);

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 Email accountname account=user%40example.com

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "accountname",
    "data": [
      {
        "account": "user"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

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

Parameters

Note:

You must use either the account or display input parameter when you call this function.

Parameter	Type	Description	Possible values	Example
account	string	The email username or email address, to return the email address or username, respectively.	The email account username (for example, user if the email address isuser@example.com), to return the email address. The email address, to return the email account username.	user@example.com
display	string	Use this parameter without theaccount parameter to return the string All Mail On Your Account.	A blank value.	''

Returns

Return	Type	Description	Possible values	Example
account	string	The email account username, the email address, or the string All Mail On Your Account. The input parameter that you use and its value determines the account return's value.	The email account username, if the account input value was an email address. The email address, if the accountinput value was a username. The string All Mail On Your Account, if you used the displayparameter.	user
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories