Child pages
  • cPanel API 2 Functions - Email::accountname

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function retrieves an email account's username.


Warning
titleWarning:

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

  • Email::account_name

    Excerpt Include
    DD:UAPI Functions - Email::account_name
    DD:UAPI Functions - Email::account_name
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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'         => '',
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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'         => '',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username Email accountname account=user%40example.com


Note
titleNote:

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



Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

Note
titleNote:

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
titleNote:

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