Child pages
  • cPanel API 1 Functions - Email::clearspambox
Skip to end of metadata
Go to start of metadata

Description

This function clears the spambox for each of a cPanel account's email addresses.

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$check_pipes = $cpanel->api1('Email', 'clearspambox'); // Call the function.


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.
my $check_pipes = $cpliveapi->api1('Email', 'clearspambox'); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::clearspambox()">
 Command Line
cpapi1 --user=username Email clearspambox


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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (HTML)
Clearing spam mailbox for user1@example.com... Done<br>
Clearing spam mailbox for user2@example.com... Done<br> 
Clearing spam mailbox for user3@example.com... Done<br> 


Parameters

This function does not accept parameters.

Returns

This function returns a message of success for each email address on the account, followed by a line break.