Child pages
  • UAPI Functions - Email::verify_password
Skip to end of metadata
Go to start of metadata

Description

This function verifies the password for an email account.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/verify_password?email=skroob%40spaceballs.com&password=12345luggage



Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Verifies that email address skrob@spaceballs.com uses a password of 12345luggage
$verify_pass = $cpanel->uapi(
    'Email', 'verify_password',
    array(
        'email'           => 'skroob%40spaceballs.com',
        'password'        => '12345luggage',
        )
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Verifies that email address skrob@spaceballs.com uses a password of 12345luggage
my $verify_pass = $cpliveapi->uapi(
    'Email', 'verify_password',
    {
        'email'           => 'skroob%40spaceballs.com',
        'password'        => '12345luggage',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- Verifies that email address skrob@spaceballs.com uses a password of 12345luggage -->
[% execute('Email', 'verify_password', { 'email' => 'skroob%40spaceballs.com', 'password' => '12345luggage' } ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Email verify_password email=skroob%40spaceballs.com password=12345luggage


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":1
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account address.

A valid email address.

skroob@spaceballs.com
passwordstring

Required

The email account password.

A secure password.

12345luggage

Returns

ReturnTypeDescriptionPossible valuesExample
dataBooleanWhether the password is valid for the email account.
  • 1 — The password is valid.
  • 0 — The password is not valid.

1