Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function unsuspends a user's ability to log in to, send mail from, and read their mail account.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/unsuspend_login?email=user%40example.com

 

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.
 
// Unsuspend logins for the user's email account.
$unsuspend_login = $cpanel->uapi(
    'Email', 'unsuspend_login',
    array(
        'email'    => 'user%40example.com',
        )
);

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.
 
# Unsuspend logins for the user's email account.
my $unsuspend_login = $cpliveapi->uapi(
    'Email', 'unsuspend_login',
    {
        'email'    => 'user%40example.com',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Suspend logins for the user's email account. -->
[% execute('Email', 'unsuspend_login', { 'email' => 'user%40example.com' } ) %]

Note:

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

 

 Command Line
uapi --user=username Email unsuspend_login email=user%40example.com

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. 
  • We introduced this functionality in cPanel & WHM version 56.

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


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

The email user's account name.

A valid email account username.

user@example.com

Returns

This function only returns metadata.