UAPI Functions - Email::suspend_incoming - Knowledgebase

Description

This function suspends incoming email for an account. The system will reject incoming email while the account is suspended.

Notes:

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

cPanel or Webmail Session URL

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

cPanel Template Toolkit

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

Command Line

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

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories