Child pages
  • cPanel API 1 Functions - Email::passwdpop
Skip to end of metadata
Go to start of metadata

 

Description

This function modifies an email account's password and disk quota.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$change_email_pass = $cpanel->api1('Email', 'passwdpop', array('user', '12345luggage', '500', 'example.com') ); // Call the function.


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.
my $change_email_pass = $cpliveapi->api1('Email', 'passwdpop', ['user', '12345luggage', '500', 'example.com'] ); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::passwdpop( $FORM('email','password','quota','domain') )">
 Command Line
cpapi1 --user=username Email passwdpop user 12345luggage 500 example.com


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (none)

This function does not return output.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account name.

The account name that corresponds to the email account.

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

user
passwordstring

Required

The email account's new password.

A secure password.12345luggage
quotainteger

Required

The maximum amount of disk space that the email account uses.

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

500
domainstring

Required

The email account's domain.

The domain that corresponds to the email account.

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

example.com

Returns

This function does not return output.