cPanel API 2 Functions - Email::addpop

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.

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=

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

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

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

Command Line

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

 Output (JSON)

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

Note:

Use cPanel's API Shell interface (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 createuser@example.com.

 example.com 

 email

 string

 Required

 The email account's username.

 A valid email account username.

 For example, user to createuser@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

 

Returns

 Return

Type

Description

Possible values

Example

 reason

 string

 A reason for failure.

 Note:

 This function only returns a reasonvalue 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

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....