cPanel API 2 Functions - Email::passwdpop - Knowledgebase

Description

This function modifies an email account's password.

Warning:

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

Email::passwd_pop — This function changes an email account's password.

Examples

WHM API (JSON)

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=

 LiveAPI PHP Class

$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',
    ) 
);

 LiveAPI Perl Module

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',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

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

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	Required The email account's domain.	A valid domain on the cPanel account. For example, example.com to modify the password for user@example.com.	example.com
email	string	Required The email account name.	A valid email account name. For example, user to modify the password foruser@example.com	user
password	string	Required The new email account password.	A secure password.	12345luggage

Returns

Return	Type	Description	Possible values	Example
reason	string	A reason for failure. Note: This function only returns a reasonvalue if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Return

Type

Description

Possible values

Example

reason

string

A reason for failure.

Note:

This function only returns a reasonvalue if it failed.

A string that describes the error.

This is an error message.

result

boolean

Whether the function succeeded.

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

Knowledgebase

Categories

Categories