How to validate an email password using the cPanel API

Introduction

In some cases, email passwords need to be validated. You can validate the password from the command line using the UAPI.

Procedure

1. Access the server's command line via SSH or "Terminal" in cPanel.
2. Use the Email verify_password option for the uapi.

   uapi --user=$cpaneluser Email verify_password email=$emailuser%40$domain.tld password=$password | grep " data"

   Please note that $cpaneluser, $emailuser, $domain.tld, and $password must be replaced with the cPanel username, the email username, the email domain, and the email account's password, respectively.
   Please note that the password is correct if the data value is 1. The password is incorrect if the data value is 0.

Additional resources

Validate email account password