UAPI Functions - Email::verify_password - Knowledgebase

Description

This function verifies the password for an email account.

Examples

cPanel or Webmail Session URL

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

 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',
        )
);

 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',
    }
);

cPanel Template Toolkit

[% execute('Email', 'verify_password', { 'email' => 'skroob%40spaceballs.com', 'password' => '12345luggage' } ) %]

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.

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":1
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The email account address.	A valid email address.	skroob@spaceballs.com
password	string	Required The email account password.	A secure password.	12345luggage

Parameter

Type

Description

Possible values

Example

string

Required

The email account address.

A valid email address.

skroob@spaceballs.com

password

string

Required

The email account password.

A secure password.

12345luggage

Returns

Return	Type	Description	Possible values	Example
data	Boolean	Whether the password is valid for the email account.	1 — The password is valid. 0 — The password is not valid.	1

Knowledgebase

Categories

Categories