cPanel API 1 Functions - Email::passwdpop - Knowledgebase

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:

UAPI (recommended) — Email::passwd_pop — This function changes an email account's password.
cPanel API 2 — Email::passwdpop — This function modifies an email account's password.

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.

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.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

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 email=user password=12345luggage quota=500 domain=example.com

Notes:

You must URI-encode these values.
username represents your account-level username.

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The email account name.	The account name that corresponds to the email account. For example, user if the email address isuser@example.com.	user
password	string	Required The email account's new password.	A secure password.	12345luggage
quota	integer	Required The maximum amount of disk space that the email account uses.	A positive integer that represents anamount of disk space, in Megabytes (MB).	500
domain	string	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.

Knowledgebase

Categories

Categories