Self Help Documentation
< All Topics

email/togglespamassassin

PostedSeptember 16, 2022
UpdatedApril 25, 2023

Description

Toggles on or off the SpamAssassin status of an existing SPanel user account.

Parameters

Additional parameters:

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
statusstringYes‘enable’ or ‘disable’.

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token', // Check API Basics for more information
  'accountuser' => 'spanelio',
  'action' => 'email/togglespamassassin',
  'status' => 'enable'
];
 
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );

Output

JSON
PHP
1
2
3
4
5
6
7
8
9
10
11
{
    "result": "success",
    "data": {
        "status": {
            "sastatus": "enabled",
            "sastatusText": "Enabled",
            "saScore": "5"
        },
        "msg": "Your SpamAssassin status has been updated successfully"
    }
}
Table of Contents