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

Description

This function suspends a user's ability to log in to their email account. This function immediately suspends the user's login credentials and prevents future authenticated connections to the email account.

Notes:

  • When you suspend an account, the user's account still receives email.
  • To suspend incoming email for an account, use the Email::suspend_incoming function.
  • To remove the login suspension for an account, use the Email::unsuspend_login function.

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/suspend_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.
 
// Suspend log in to the user's email account.
$suspend_login = $cpanel->uapi(
    'Email', 'suspend_login',
    array(
        'email' => 'user@example.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.
 
# Suspend log in to the user's email account.
my $suspend_login = $cpliveapi->uapi(
    'Email', 'suspend_login',
    {
        'email' => 'user@example.com',
    }
);


Note:

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

 cPanel Template Toolkit
<!-- Suspend log in to the user's email account. -->
[% execute('Email', 'suspend_login', { 'email_address' => 'user@example.com' } ) %]


Note:

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

 Command Line
uapi --user=username Email suspend_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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
      "messages":["Logins for “user@example.com” are suspended."],
      "data":null,
      "errors":null,
      "status":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 user's account name.

A valid email account username.

user@example.com

Returns

This function only returns metadata.