Description

This function adds an email account.


Examples 




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$new_email_account = $cpanel->api1('Email', 'addpop', array('user', '12345luggage', '500', 'example.com') ); // Call the function.



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $new_email_account = $cpliveapi->api1('Email', 'addpop', ['user', '12345luggage', '500', 'example.com'] ); # Call the function.


<cpanel Module="Email::addpop( $FORM('email','password','quota','domain') )">




cpapi1 --user=username Email addpop user 12345luggage 500 example.com



user@example.com 




Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account name.

 

A valid email account name.

For example, user if the email address is user@example.com.

user
passwordstring

Required

The email account password.

A secure password. 12345luggage
quotainteger

Required

The maximum amount of disk space that the new email account may use.

A positive integer.

To grant the account unlimited disk space, specify 0 for this parameter. 


500
domainstring

Required

The email account's domain.

The domain that corresponds to the email account.

For example, example if the email address is user@example.com.

example.com

Returns

This function returns the new email address, in email@domain.tld format.