Self Help Documentation
< All Topics

email/addemailfilter

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.
domainstringYesThe existing domain to have a new filter created.
namestringYesNew filter name.
rulestringYes‘from’ / ‘subject’ / ‘anyheader’ / ‘spamscore’
checkstringYes‘contains’ / ‘not-contains’ / ‘is’
valuestringYesString to check against. No spaces allowed.

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'email/addemailfilter',
  'domain' => 'spanel.io',
  'name' => 'new filter name',
  'rule' => 'from',
  'check' => 'contains',
  'value' => 'fromContainsThis'
];
 
$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
10
{
    "result": "success",
    "data": {
        "msg": "Filter named <b>new filter name</b> was created successfully",
        "existingFilterNames": [
            "filter name",
            "new filter name"
        ]
    }
}
Table of Contents