Description
This function changes an email account's password.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/passwd_pop?email=user&password=12345luggage&domain=example.com
LiveAPI PHP Class
$cpanel = new CPANEL();
$new_passwd = $cpanel->uapi(
'Email', 'passwd_pop',
array(
'email' => 'user',
'password' => '12345luggage',
'domain' => 'example.com',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $new_passwd = $cpliveapi->uapi(
'Email', 'passwd_pop',
{
'email' => 'user',
'password' => '12345luggage',
'domain' => 'example.com',
}
);
cPanel Template Toolkit
[% execute('Email', 'passwd_pop', { 'email' => 'user', 'password' => '12345luggage', 'domain' => 'example.com' } ) %]
Command Line
uapi --user=username Email passwd_pop email=user password=12345luggage domain=example.com
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
},
"data":null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
email
|
string
|
Required
The email account username or address.
|
- A valid email account username. For example, user if the email address is user@example.com.
- A valid email address.
|
user
|
|
password
|
string
|
Required
The email account password.
|
A secure password.
|
12345luggage
|
|
domain
|
string
|
The email account's domain.
This parameter defaults to the cPanel account's main domain.
|
A valid domain on the cPanel account.
For example, example.com if the email address isuser@example.com.
|
example.com
|
Returns
This function only returns metadata.
