Description

This function adds an email account.


We strongly recommend that you use the following UAPI function instead of this function:

Examples 




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=addpop&domain="example.com"&email="user"&password="12345luggage"&quota="500"



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Create the user@example.com email address.
$add_email_address = $cpanel->api2(
    'Email', 'addpop', 
    array(
        'domain'          => 'example.com', 
        'email'           => 'user', 
        'password'        => '12345luggage',
        'quota'           => '500',
    ) 
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Create the user@example.com email address.
my $add_email_address = $cpliveapi->api2(
    'Email', 'addpop',
    { 
        'domain'          => 'example.com', 
        'email'           => 'user', 
        'password'        => '12345luggage',
        'quota'           => '500',
    }
);

 




cpapi2 --user=username Email addpop domain=example.com email=user password=12345luggage quota=500


For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.  




{
  "cpanelresult": {
    "apiversion": 2,
    "func": "addpop",
    "data": [
      {
        "reason": "",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The email account's domain.

A valid domain on the cPanel account.

For example, example.com to create user@example.com.

example.com
emailstring

Required

The email account's username.

A valid email account username.

In cPanel & WHM version 78 and later, you cannot enter cpanel as an account name when you create an email account.

For example, user to create user@example.com.

user
passwordstring

Required

The email account's password.

A secure password.

12345luggage
quotainteger

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

This parameter defaults to 250.

A positive integer that represents the maximum amount of disk space, in Megabytes (MB).

To grant unlimited disk space, specify 0.


500
send_welcome_email Boolean

Whether to send client configuration instructions to the account.

We introduced this parameter in cPanel & WHM version 62.

This parameter defaults to 0.

  • 1 — Send the instructions.
  • 0 — Do not send the instructions.
0

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

A reason for failure.

This function only returns a reason value if it failed. 


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1