Description

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



Examples 




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



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $check_pipes = $cpliveapi->api1('Email', 'clearspambox'); # Call the function.

 


<cpanel Module="Email::clearspambox()">




cpapi1 --user=username Email clearspambox



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.