# cPanel API 2 Functions - Email::addpop

Warning:

The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function adds an email account.

br
Warning:
br
We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function:

- ` Email::add_pop ` — This function creates an email address.


br
div
Important:
br
When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

br
## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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"
```

div
Note:
br
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

br
LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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',
    )
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

br
LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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',
    }
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

br
cPanel Tag System (deprecated)

div
Warnings:
br
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


br
Command Line


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

div
Note:
br
For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.

br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "addpop",
    "data": [
      {
        "reason": "",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}
```

div
Note:
br
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

br
## Parameters

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
domain
td
em
string
td
p
strong
Required
p
The email account's domain.
td
p
A valid domain on the cPanel account.
p
For example, 
code
example.com
 to create 
code
user@example.com
.
td
code
example.com
tr
td
code
email
td
em
string
td
p
strong
Required
p
The email account's username.
td
div
p
A valid email account username.
p
div
Note:
br
p
p
You 
strong
cannot
 enter 
code
cpanel
 as an account name when you create an email account.
p
For example, 
code
user
 to create 
code
user@example.com
.
td
code
user
tr
td
code
password
td
em
string
td
p
strong
Required
p
The email account's password.
td
p
A secure password.
td
code
12345luggage
tr
td
code
quota
td
em
integer
td
p
The maximum amount of disk space that the new email account may use.
p
This parameter defaults to 
code
250
.
td
div
p
A positive integer that represents the maximum amount of disk space, in megabytes (MB).
p
div
Note:
br
p
p
To grant unlimited disk space, specify 
code
0
.
td
code
500
tr
td
code
send_welcome_email 
td
em
Boolean
td
div
p
Whether to send client configuration instructions to the account.
p
This parameter defaults to 
code
0
.
td
ul
li
code
1
 — Send the instructions.
li
code
0
 — Do 
strong
not
 send the instructions.
td
code
0
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
reason
td
em
string
td
div
p
A reason for failure.
p
div
Note:
br
p
p
This function only returns a 
code
reason
 value if it failed. 
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1