Description

This function checks whether Apache SpamAssassin™ Spam Box is enabled.

Examples 




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



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

 


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




cpapi1 --user=username Email spamboxstatus



Enabled 

or

Disabled 




   

Parameters

This function does not accept parameters.

Returns

  • Enabled — Apache SpamAssassin Spam Box is enabled.
  • Disabled — Apache SpamAssassin Spam Box is disabled.