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

 

Description

This function retrieves the username that an account uses to authenticate with the mail server.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_mail_server_user = $cpanel->api1('Email', 'getmailserveruser', array('user@example.com') ); // Call the function.


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.
my $get_mail_server_user = $cpliveapi->api1('Email', 'getmailserveruser', ['user@example.com'] ); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::getmailserveruser( $FORM('account') )">
 Command Line
cpapi1 --user=username Email getmailserveruser user@example.com


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)
user+example.com

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

A valid email address on the server.

user@example.com

Returns

This function returns the username that the account uses to authenticate with the mail server. This username is similar to the account's email address, but replaces the @ character with the + character.

For example, the authentication username for the user@example.com email address is user+example.com.