Page tree

Versions Compared

Key

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

Description

Excerpt

This function checks whether Apache SpamAssassin™ is enabled.


Note
titleNote:

For more information, read our Apache SpamAssassin documentation. 


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended) Email::get_spam_settings
    Excerpt Include
    UAPI Functions - Email::get_spam_settings
    UAPI Functions - Email::get_spam_settings
    nopaneltrue


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.
$spamassassin_status = $cpanel->api1('Email', 'spamstatus'); // 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 $spamassassin_status = $cpliveapi->api1('Email', 'spamstatus'); # 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::spamstatus() )">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Email spamstatus

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
languagetext
Enabled 

or

Code Block
languagetext
Disabled 




   

Parameters

This function does not accept parameters.

Returns

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