Validate email account password

This function verifies the password for an email account.

Important:

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

Authorizations:
query Parameters
email
required
string <email>

The email account address.

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

The email account password.

Example: password=123456luggage

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 --output=jsonpretty \
  --user=username \
  Email \
  verify_password \
  email='username@example.com' \
  password='123456luggage'

Response samples

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