Description

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

Examples 

$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.

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.

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

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.

Function information

Module:

Email

API Version:

cPanel API 1

Available in:

cPanel 11+

Methods:

GET, POST

Required Parameters:

account

Return Formats:

plaintext

About this module

The Email module modifies cPanel email account settings.

About cPanel API 1

  

Find a function

Related functions