# cPanel API 2 Functions - Email::accountname

div
Warning:
br
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

br
## Description

This function retrieves an email account's username.

div
Warning:
br
We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function:

- `Email::account_name` — This function returns the provided value. This function works with other functions to display form data within a user interface.


br
div
Important:
br
When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

br
## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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"
```

div
Note: 
br
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

br
LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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'         => '',
    )
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

br
LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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'         => '',
    }
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

br
cPanel Tag System (deprecated)

div
Warnings:
br
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


br
Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Email accountname account=user%40example.com
```

div
Note:
br
For more information and additional output options, read our  [Guide to cPanel API 2](/cpanel-api-2/)  documentation or run the  `cpapi2 --help`  command.  

Output (JSON)


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

div
Note:
br
Use cPanel's [*API Shell*](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel) interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

br
## Parameters

div
Note:
br
You **must** use either the `account` **or** `display` input parameter when you call this function.

br
table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
account
td
em
string
td
p
The email username or email address, to return the email address or username, respectively.
td
ul
li
The email account username (for example, 
code
user
 if the email address is 
code
user@example.com
), to return the email address.
li
The email address, to return the email account username.
td
code
user@example.com
tr
td
code
display
td
em
string
td
Use this parameter without the 
code
account
 parameter to return the string 
code
All Mail On Your Account
.
td
A blank value.
td
code
''
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
account
td
em
string
td
p
The email account username, the email address, or the string 
code
All Mail On Your Account
.
p
The input parameter that you use and its value determines the 
code
account
 return's value.
td
ul
li
The email account username, if the 
code
account
 input value was an email address.
li
The email address, if the 
code
account
 input value was a username.
li
The string 
code
All Mail On Your Account
, if you used the 
code
display
 parameter.
td
code
user
tr
td
code
reason
td
em
string
td
p
A reason for failure.

This function only returns a 
code
reason
 value if it failed.

td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1