Update email account password

This function changes an email account's password.

Important:

When you disable the Receive Mail role, the system disables this function.

Authorizations:
query Parameters
required
string or string

The email account username or address.

Example: email=username@example.com
password
required
string

The email account password.

Example: password=12345luggage
domain
string <domain>
Default: "the cPanel account's main domain"

The email account's domain.

Example: domain=example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Email passwd_pop email='username@example.com' password='12345luggage'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "passwd_pop",
  • "module": "Email",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}