cPanel API 1 Functions - Email::addpop - Knowledgebase

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:

UAPI (recommended) — Email::add_pop — This function creates an email address.
cPanel API 2 — Email::addpop — This function adds an email account.

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.

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.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

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

Output (plaintext)

user@example.com

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The email account name. For example, user if the email address will be user@example.com.	A valid email account name.	user
password	string	Required The email account password.	A secure password.	12345luggage
quota	integer	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
domain	string	Required The email account's domain. For example, example.com if the email address is user@example.com.	The domain that corresponds to the email account.	example.com

Returns

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

Knowledgebase

Categories

Categories