Last updated 3 months ago

cPanel API 2 Functions - Email::addpop

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function adds an email account.

Warning:

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

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

Important:

When you disable the Receive Mail role, the system disables this function.

Examples

WHM API (JSON)

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"

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$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',
    )
);

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.

# Create the user@example.com email address.
my $add_email_address = $cpliveapi->api2(
    'Email', 'addpop',
    {
        'domain'          => 'example.com',
        'email'           => 'user',
        'password'        => '12345luggage',
        'quota'           => '500',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI 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 .
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 documentation.

Command Line

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

Note:

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

Output (JSON)

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

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
`domain`	string	Required The email account's domain.	A valid domain on the cPanel account. For example, `example.com` to create `user@example.com`.	`example.com`
`email`	string	Required The email account's username.	A valid email account username. Note: You cannot enter `cpanel` as an account name when you create an email account. For example, `user` to create `user@example.com`.	`user`
`password`	string	Required The email account's password.	A secure password.	`12345luggage`
`quota`	integer	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). Note: To grant unlimited disk space, specify `0`.	`500`
`send_welcome_email`	Boolean	Whether to send client configuration instructions to the account. This parameter defaults to `0`.	`1` — Send the instructions. `0` — Do not send the instructions.	`0`

Returns

Return	Type	Description	Possible values	Example
`reason`	string	A reason for failure. Note: This function only returns a `reason` value if it failed.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`