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.

SecurityBasicAuth

Request

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

200

HTTP Request was successful.

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

get/Email/verify_password

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  verify_password \
  email='username@example.com' \
  password='123456luggage'

Response samples

application/json

{"apiversion": 3,
"func": "verify_password",
"module": "Email",
"result": {"data": 1,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}