Description

This function modifies an email account's password.

We strongly recommend that you use the following UAPI function instead of this function:

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=passwdpop&domain="example.com"&email="user"&password="12345luggage"

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Update the password for user@example.com.
$update_email_passwd = $cpanel->api2(
    'Email', 'passwdpop', 
    array(
        'domain'          => 'example.com', 
        'email'           => 'user', 
        'password'        => '12345luggage',
    ) 
);

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Update the password for user@example.com.
my $update_email_passwd = $cpliveapi->api2(
    'Email', 'passwdpop',
    { 
        'domain'          => 'example.com', 
        'email'           => 'user', 
        'password'        => '12345luggage',
    }
);

cpapi2 --user=username Email passwdpop domain=example.com email=user password=12345luggage

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

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The email account's domain.

A valid domain on the cPanel account.

 

example.com
emailstring

Required

The email account name.

A valid email account name.

 

user
passwordstring

Required

The new email account password.

A secure password.

12345luggage

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

A reason for failure.

This function only returns a reason value if it failed. 

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1