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

Description

This function adds an email account.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Important:

In cPanel & WHM version 76, the MailReceive role affects this function.

Examples 


 LiveAPI PHP Class
$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.


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 $new_email_account = $cpliveapi->api1('Email', 'addpop', ['user', '12345luggage', '500', '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::addpop( $FORM('email','password','quota','domain') )">
 Command Line
cpapi1 --user=username Email addpop user 12345luggage 500 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
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.

Note:

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.