Description

This function suspends incoming email for an account.

 The system will reject incoming email while the account is suspended.

  • The user can still log in to the email account. To suspend a user's ability to log in to, send mail from, and read their account, use the Email::suspend_login function.
  • Use the Email::unsuspend_incoming function to allow the account to receive email.

Examples




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

 



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

 



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

 



<!-- Suspend  incoming mail for the user's email account. -->
[% execute('Email', 'suspend_incoming', { 'email' => 'user@example.com' } ) %]

 



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



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



Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

The email user's account name.

A valid email account username.

user@example.com

Returns

This function only returns metadata.