cPanel API 1 Functions - Email::spamstatus - Knowledgebase

Description

This function checks whether Apache SpamAssassin™ is enabled.

Warning:

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

UAPI (recommended) — Email::get_spam_settings — This function retrieves the Apache SpamAssassin™ settings for the account.

Examples

LiveAPI PHP Class

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

LiveAPI Perl Module

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

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

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

Command Line

cpapi1 --user=username Email spamstatus

Notes:

You must URI-encode these values.
username represents your account-level username.

Output (plaintext)

Enabled

Disabled

Parameters

This function does not accept parameters.

Returns

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

Knowledgebase

Categories

Categories