email/addemailfilter
Description
Adds a new sender in SpamAssassin’s white or blacklist for an existing SPanel user account.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| token | string | Yes | Authorizing API token – check API Basics for more information. |
| accountuser | string | Yes | The SPanel user account that is being managed or viewed. |
| action | string | Yes | The category and function being executed. |
| domain | string | Yes | The existing domain to have a new filter created. |
| name | string | Yes | New filter name. |
| rule | string | Yes | ‘from’ / ‘subject’ / ‘anyheader’ / ‘spamscore’ |
| check | string | Yes | ‘contains’ / ‘not-contains’ / ‘is’ |
| value | string | Yes | String to check against. No spaces allowed. |
Example
$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
{
"result": "success",
"data": {
"msg": "Filter named <b>new filter name</b> was created successfully",
"existingFilterNames": [
"filter name",
"new filter name"
]
}
}