How to validate a password using the cPanel API

Introduction

In some cases, E-Mail passwords need to be validated, however setting up an e-mail client can be a time-consuming process. Using the UAPI you can validate the password from the command line

Procedure

This is an example of the verify_password function of the UAPI:

uapi --user=example Email verify_password email=test%40example.com password=Luggage123
---
apiversion: 3
func: verify_password
module: Email
result:
 data: 1
 errors: ~
 messages: ~
 metadata: {}

status: 1
 warnings: ~

In this case, the password was correct, so data returned 1 if the password validation failed. If the password failed validation, it would have returned 0.

You can reference our documentation for this API call here:

https://documentation.cpanel.net/display/DD/UAPI+Functions+-+Email%3A%3Averify_password