Self Help Documentation
< All Topics

email/addspamassassinsender

PostedSeptember 16, 2022
UpdatedApril 26, 2023

Description

Adds a new sender in SpamAssassin’s white or blacklist for an existing SPanel user account.

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.
typestringYes‘blacklist’ or ‘whitelist’.
senderstringYesThe sender domain to add.

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'email/addspamassassinsender',
  'type' => 'whitelist',
  'sender' => 'testwhitelist.com'
];
 
$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 );

You can find more information about the Endpoint URL in our API Basics article.

Output

JSON
PHP
1
2
3
4
5
6
7
8
9
{
    "result": "success",
    "data": {
        "type": 2,
        "msg": [
            "testwhitelist.com has been added to the SA whitelist for user spanelio"
        ]
    }
}
Table of Contents