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

Description

This function retrieves an email account's username.

Warning:

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

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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="user@example.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 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'         => '',
    ) 
);


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


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

Note:

For more information and additional output options, read our  Guide to cPanel API 2  documentation or run the  cpapi2 --help  command.  

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


Note:

Use cPanel's API Shell interface (cPanel >> 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. 

ParameterTypeDescriptionPossible valuesExample
accountstring

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 is user@example.com), to return the email address.
  • The email address, to return the email account username.
user@example.com
displaystringUse this parameter without the account parameter to return the string All Mail On Your Account.A blank value.''

Returns

ReturnTypeDescriptionPossible valuesExample
accountstring

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 account input value was a username.
  • The string All Mail On Your Account, if you used the display parameter.
user
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 — The function succeeded.
  • 0 — The function failed.
1