Child pages
  • cPanel API 1 Functions - Email::clearspambox

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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


Warning

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)Mailboxes::expunge_mailbox_messages
    Excerpt Include
    UAPI Functions - Mailboxes::expunge_mailbox_messages
    UAPI Functions - Mailboxes::expunge_mailbox_messages
    nopaneltrue
    • Enter mailbox= INBOX.spam for the mailboxparameter.
  • cPanel API 2 None.


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


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

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


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

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Email::clearspambox()">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Email clearspambox

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (HTML)


Code Block
languagexml
linenumberstrue
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.