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.

  • 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.

Examples




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



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



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



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



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



{  
      "messages":["Logins for “user@example.com” are suspended."],
      "data":null,
      "errors":null,
      "status":1
}



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.