UAPI Functions - Email::suspend_login - Knowledgebase

Description

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

Notes:

The system will drop the user's email connection immediately.
The account will still receive email. To suspend incoming email for an account, use the Email::suspend_incoming function.
Use the Email::unsuspend_login function to remove the login suspension.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/suspend_login?email=user%40example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Suspend log in to the user's email account.
$suspend_login = $cpanel->uapi(
    'Email', 'suspend_login',
    array(
        'email'    => 'user@example.com',
        )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Suspend log in to the user's email account.
my $suspend_login = $cpliveapi->uapi(
    'Email', 'suspend_login',
    {
        'email'    => 'user@example.com',
    }
);

cPanel Template Toolkit

[% execute('Email', 'suspend_login', { 'email_address' => 'user@example.com' } ) %]

Command Line

uapi --user=username Email suspend_login email=user%40example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

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

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 user's account name.	A valid email account username.	user@example.com

Parameter

Type

Description

Possible values

Example

string

Required

The email user's account name.

A valid email account username.

user@example.com

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories