Child pages
  • cPanel API 1 Functions - Email::addpop

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function adds an email account.


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended) Email::add_pop
    Excerpt Include
    DD:UAPI Functions - Email::add_popDD:
    UAPI Functions - Email::add_pop
    nopaneltrue
  • cPanel API 2 Email::addpop
    Excerpt Include
    DD:cPanel API 2 Functions - Email::addpopDD:
    cPanel API 2 Functions - Email::addpop
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

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



Expand
titleCommand Line


Code Block
cpapi1 --user=username Email addpop user 12345luggage 500 example.com

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
languagetext
user@example.com 




Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account name.

 

A valid email account name.

For example, user if the email address is user@example.com.

user
passwordstring

Required

The email account password.

A secure password. 12345luggage
quotainteger

Required

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

A positive integer.

Note
titleNote:

To grant the account unlimited disk space, specify 0 for this parameter. 


500
domainstring

Required

The email account's domain.

The domain that corresponds to the email account.

For example, example if the email address is user@example.com.

example.com

Returns

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