Spam Experts

https://documentation.n-able.com/spamexperts/userguide
Admin
Spam Experts is an email filtering and security solution that provides spam protection, email...
Tokens:235,198
Snippets:2,159
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### DirectAdmin API Configuration Example

Source: https://documentation.n-able.com/spamexperts/userguide/Content/Integration/directadmin-addon

This code snippet demonstrates the configuration parameters for connecting to the DirectAdmin API. It includes settings for host, port, security (SSL), username, and password.

```ini
; Setup values needed to DirectAdmin API
host=127.0.0.1
port=2222
; 1 or 0
secure=0
username=admin
password=xxxxxx
```

--------------------------------

### Deploy Zimbra Add-on via Command Line

Source: https://documentation.n-able.com/spamexperts/userguide/Content/Integration/zimbra-addon

This command deploys the Spam Experts Zimbra add-on from a zip file to the Zimbra server. Ensure the zip file is uploaded to the correct directory before execution. The output confirms successful deployment and installation.

```bash
/opt/zimbra/bin/zmzimletctl deploy /opt/zimbra/zimlets/com_zimbra_spamexperts.zip
```

--------------------------------

### Regex Examples for Domain and IP Filtering

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/B_Admin%20Level/incoming-filtering/adv-inc-blocklist-rule-examples

This section provides generic and example regular expressions for matching domains, IP addresses, and combinations thereof. It includes examples for exact matches, wildcards, and IP addresses at the end of a string.

```regex
(?i)(\\@domain\\.ext)
(?i)(domain\\.ext)
(?i)(domain\\.ext)\\(10\\.10\\.10\\.10)
10.10.10.10
(?s){10.10.10.10}
(?i)^10\\.10\\.10.*
(?i)^(10\\.10\\.10\\.10)$
```

--------------------------------

### Add Domain Examples

Source: https://documentation.n-able.com/spamexperts/userguide/Content/Integration/int-own-sft

Examples for adding a domain using both the Control Panel API and the Software API.

```APIDOC
## Adding a Domain

### Control Panel API
```
/api/domain/add/domain/demo-domain.invalid/destinations/%5B%22mail.demo-domain.invalid%22%5D
```

### Software API
```
/cgi-bin/api?call=api_add_incoming_domain&domain=demo-domain.invalid&destination=mail.demo-domain.invalid
```
```

--------------------------------

### Regex Examples for Country Filtering

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/B_Admin%20Level/incoming-filtering/adv-inc-blocklist-rule-examples

This section offers regular expressions for filtering based on country names and ISO codes. It includes examples for single countries, multiple countries, and specific country ISO alpha-2 codes.

```regex
country1
(?i)^(ISO Alpha2 code)$
country one|Country2|Country3
```

--------------------------------

### General API Call Example using wget

Source: https://documentation.n-able.com/spamexperts/userguide/Content/Integration/int-own-sft

Illustrates how to make an API call using a command-line tool like wget. While simple, this method is less suitable for parsing responses compared to scripting languages. It demonstrates the basic structure of an API endpoint for adding a domain.

```bash
wget "https://api.demo-domain.invalid/api/domain/add/domain/demo-domain.invalid/destinations/\"mail.demo-domain.invalid\"/format/json/"
```

--------------------------------

### Regex Examples for Keyword and Phrase Filtering in Spam Experts

Source: https://documentation.n-able.com/spamexperts/userguide/Content/B_Admin%20Level/incoming-filtering/adv-inc-blocklist-rule-examples

This set of regular expressions targets specific keywords or phrases within emails. It includes examples for single keywords, multiple words in sequence, and common phrases found in spam.

```regex
(?i)(word)
(?i)(bitcoins)
```

```regex
(?i)(word1\\ word2\\ word3)
(?i)(pending\\ message\\ waiting)
```

```regex
(?i)word1 word2 word3 word4 word5 word6
(?i)Account will be disabled within 48hours
```

```regex
(? i) (Posted on Sunday) | (Order confirmed) | (Due to a problem sign activity) | (Summary)
(? i) (Posted on Sunday) | (Order confirmed) | (Due to a problem sign activity) | (Summary)
```

```regex
(?msi)(Prefer fewer emails from me\? Click here|If you don\'t want further emails, please Unsubscribe|If you\'d like me to stop sending you emails, please click here\<https)
(?msi)(Prefer fewer emails from me\? Click here|If you don\'t want further emails, please Unsubscribe|If you\'d like me to stop sending you emails, please click here\<https)
```

```regex
(?i)^(Transfer\\ fee\\-\ NEW\\ SALES\\ AGREEMENT)$
(?i)^(Transfer\\ fee\\-\ NEW\\ SALES\\ AGREEMENT)$
```

--------------------------------

### Add Domain Alias Examples

Source: https://documentation.n-able.com/spamexperts/userguide/Content/Integration/int-own-sft

Examples for adding a domain alias using both the Control Panel API and the Software API.

```APIDOC
## Adding a Domain Alias

### Control Panel API
```
api/domainalias/add/domain/demo-domain.invalid/alias/domain-alias.invalid
```

### Software API
```
cgi-bin/api?call=api_add_domain_alias&domain=demo-domain.invalid&alias=domain-alias.invalid
```
```

--------------------------------

### Set DKIM Selector for User

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/qsg/set-up-dkim

This API endpoint associates a DKIM selector with a specific user for outgoing emails.

```APIDOC
## POST /cgi-bin/api?call=api_set_dkim_selector

### Description
Associates a DKIM selector with a specific user for outgoing emails, ensuring emails from this user are signed with the configured DKIM key.

### Method
GET

### Endpoint
https://SERVERNAME/cgi-bin/api?call=api_set_dkim_selector

### Parameters
#### Query Parameters
- **domain** (string) - Required - The domain name associated with the user.
- **selector** (string) - Required - The DKIM selector to associate with the user.
- **username** (string) - Required - The username of the outgoing email user.

### Request Example
```
https://YOUR_SERVERNAME/cgi-bin/api?call=api_set_dkim_selector&domain=example.com&selector=selector1&username=user@example.com
```

### Response
#### Success Response (200)
This endpoint does not explicitly define a success response body in the provided documentation. Typically, API calls of this nature return a status or confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "DKIM selector set for user successfully"
}
```
```

--------------------------------

### Making API Calls

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/Integration/int-own-sft

Information on how to make API calls using various HTTP-aware libraries or scripting languages, with a PHP example using `file_get_contents` to add a domain.

```APIDOC
## Making API Calls

You can make API calls with any HTTP-aware library/scripting language or application. It does not matter whether this is something as simple as **wget** or more complex such as **PHP** or **Python**.

The latter two are better since they are also able to parse the output/JSON and determine whether the call succeeded.

For PHP you can make use of the **file_get_contents** call:

```php
$result = json_decode(file_get_contents( "https://api.demo-domain.invalid/api/domain/add/domain/demo-domain.invalid/destinations/%5B%22mail.demo-domain.invalid%22%5D/format/json/" ));
```

The **$result** parameter will then contain the array of the resulting content which can be further parsed/processed.
```

--------------------------------

### Get Outgoing Interfaces API

Source: https://documentation.n-able.com/spamexperts/userguide/Content/se/lc/deliv-ip-mgmt

Retrieves a list of IP addresses that are currently active for a specified domain and username.

```APIDOC
## GET /cgi-bin/api

### Description
Retrieves a list of IP addresses that are currently active for a specified domain and username.

### Method
GET

### Endpoint
https://SERVERNAME/cgi-bin/api?call=api_get_outgoing_interfaces

### Parameters
#### Query Parameters
- **call** (string) - Required - Must be `api_get_outgoing_interfaces`.
- **domain** (string) - Optional - The domain for which to retrieve IP details. Use "default" for all users.
- **username** (string) - Optional - The username for which to retrieve IP details. Leave blank when domain is "default".

### Request Example
```
https://SERVERNAME/cgi-bin/api?call=api_get_outgoing_interfaces&domain=example.com&username=user@example.com
https://SERVERNAME/cgi-bin/api?call=api_get_outgoing_interfaces&domain=default
```

### Response
#### Success Response (200)
- **IP Addresses** (list of strings) - A list of active outgoing IP addresses.
```

--------------------------------

### API Help Documentation

Source: https://documentation.n-able.com/spamexperts/userguide/Content/se/lc/lc-monitor-change

Access detailed help documentation for all available API calls, including descriptions and return data formats.

```APIDOC
## GET /cgi-bin/api?call=api_help

### Description
Access detailed help documentation for all available API calls, including descriptions and return data formats.

### Method
GET

### Endpoint
https://API_USER:API_PASS@PRIMARY_HOSTNAME/cgi-bin/api?call=api_help

### Parameters

#### Query Parameters
- **call** (string) - Required - Specifies the API function to call, set to 'api_help'.

### Response
#### Success Response (200)
- **Help Documentation** (string) - Detailed text describing API calls and their usage.

#### Response Example
```
API Help Documentation:

- api_get_server_status: Retrieves server status in plain text format.
  Returns: HOSTNAME,LOAD AVG1,LOAD AVG5,LOAD AVG15,MEM USAGE,DISK USAGE

- api_get_json_server_status: Retrieves server status in JSON format.
  Returns: JSON object with server details.

- api_help: Displays this help documentation.
```
```

--------------------------------

### Regex Examples for Word and Phrase Filtering

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/B_Admin%20Level/incoming-filtering/adv-inc-blocklist-rule-examples

This section provides regular expressions for matching specific keywords, multiple words in a string, and common phrases found in spam, such as fake order confirmations or cold email indicators. It includes examples for case-insensitive matching and multi-line matching.

```regex
(?i)(word)
(?i)(word1 word2 word3)
(?i)word1 word2 word3 word4 word5 word6
(? i) (Posted on Sunday) | (Order confirmed) | (Due to a problem sign activity) | (Summary)
(?msi)(Prefer fewer emails from me\? Click here|If you don\'t want further emails, please Unsubscribe|If you\'d like me to stop sending you emails, please click here<https)
(?i)^(Transfer\ fee\\- NEW SALES AGREEMENT)$
```

--------------------------------

### Control Panel API - Add Domain

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/Integration/int-own-sft

Example of adding a domain using the Control Panel API.

```APIDOC
## Control Panel API - Add Domain

### Description
Adds a domain to the Spam Experts system using the Control Panel API.

### Method
GET

### Endpoint
`/api/domain/add/domain/{domain}/destinations/{destinations}`

### Parameters
#### Path Parameters
*   **domain** (string) - Required - The domain name to add.
*   **destinations** (array of strings) - Required - An array of destination IP addresses or hostnames for the domain's email.

### Request Example
`GET /api/domain/add/domain/demo-domain.invalid/destinations/%5B%22mail.demo-domain.invalid%22%5D`
```

--------------------------------

### Configure Postfix for Spam Experts Incoming Filtering (Per Domain)

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/Integration/conf-incoming-postfix

This setup allows Postfix to accept mail only from Spam Experts servers for specific protected domains. It involves creating two Postfix access files and configuring recipient restrictions. This method is useful for multi-domain setups.

```bash
sudo postmap /etc/postfix/Spam Experts
sudo postmap /etc/postfix/protected_destinations
sudo postfix reload
/etc/init.d/postfix restart
```

```postfix
# /etc/postfix/Spam Experts
antispamcloud.com OK
demo-domain.invalid OK
localhost OK
localdomain OK
```

```postfix
# /etc/postfix/protected_destinations
demo-domain.invalid Spam Experts
```

```postfix
# /etc/postfix/main.cf
smtpd_restriction_classes = Spam Experts
Spam Experts = check_client_access hash:/etc/postfix/Spam Experts, reject
smtpd_recipient_restrictions = check_recipient_access hash:/etc/postfix/protected_destinations, permit_mynetworks, permit_sasl_authenticated, reject_unauth_destination
```

--------------------------------

### LDAP Filter Example for Spam Experts

Source: https://documentation.n-able.com/spamexperts/userguide/Content/C_Domain%20Level/ldap/conf-ldap-sync

This example demonstrates how to construct an LDAP filter for synchronizing user accounts in Spam Experts. It excludes health mailboxes and disabled accounts by checking the objectClass and userAccountControl attributes. The filter syntax is based on Python's regular expression (regex) syntax.

```regex
(&(!(mail=health*))(objectClass=user)(!(userAccountControl:1.2.840.113556.1.4.803:=2)))
```

--------------------------------

### API Help Documentation

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/se/lc/lc-monitor-change

Accesses the API help documentation which provides detailed information on available calls and their return data.

```APIDOC
## GET /cgi-bin/api?call=api_help

### Description
Retrieves detailed help documentation for the Software API, including descriptions of all available calls and the data they return.

### Method
GET

### Endpoint
https://API_USER:API_PASS@PRIMARY_HOSTNAME/cgi-bin/api?call=api_help

### Parameters
#### Query Parameters
- **call** (string) - Required - Must be set to `api_help`.

### Request Example
```bash
curl -k "https://API_USER:API_PASSWORD@PRIMARY_HOSTNAME/cgi-bin/api?call=api_help"
```

### Response
#### Success Response (200)
- **Output**: HTML or plain text containing API help documentation.

#### Response Example
(Content will vary based on the API documentation structure.)
```

--------------------------------

### Get Outgoing Delivery IP Addresses

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/se/lc/deliv-ip-mgmt

Retrieves a list of active IP addresses for a specified domain and username. Supports retrieving default values for all users.

```APIDOC
## GET /cgi-bin/api

### Description
Retrieves a list of IP addresses that are currently active for outgoing delivery.

### Method
GET

### Endpoint
`https://SERVERNAME/cgi-bin/api`

### Query Parameters
* **call** (string) - Required - Must be `api_get_outgoing_interfaces`.
* **domain** (string) - Required - The domain for which to retrieve IP details. Use "default" for all users.
* **username** (string) - Optional - The username for which to retrieve IP details. Leave blank when domain is "default".

### Response
#### Success Response (200)
- **ip_list** (array) - A list of outgoing IP addresses.

### Response Example
```json
{
  "status": "success",
  "data": [
    "192.168.1.1",
    "192.168.1.2"
  ]
}
```
```

--------------------------------

### Software API - General Information

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/Integration/software-api

The Spam Experts Software API allows for programmatic control of the Local Cloud setup. All available commands can be listed via the 'api_help' call.

```APIDOC
## Software API - General Information

### Description
The Software API exposes all functionality of the Spam Experts Local Cloud setup. It is accessible via HTTPS and can be called from any external location using URL calls.

### API Help
To get a full listing of all available commands, use the `api_help` call.

**Endpoint:** `https://SERVERNAME/cgi-bin/api?call=api_help`

### Access
- The API is accessible via HTTPS.
- Commands can be executed from any external location, not from the SSH command line.
- Commands are executed on all relevant servers in the Local Cloud setup automatically.

### Product Specificity
- This API is **only** available for the Local Cloud product.
- For Hosted Cloud/Control Panel API, refer to the Control Panel API documentation.
```

--------------------------------

### Software API - Add Domain

Source: https://documentation.n-able.com/spamexperts/userguide/qsg/Content/Integration/int-own-sft

Example of adding a domain using the Software API.

```APIDOC
## Software API - Add Domain

### Description
Adds a domain to the Spam Experts system using the Software API.

### Method
GET

### Endpoint
`/cgi-bin/api?call=api_add_incoming_domain&domain={domain}&destination={destination}`

### Parameters
#### Query Parameters
*   **call** (string) - Required - Must be `api_add_incoming_domain`.
*   **domain** (string) - Required - The domain name to add.
*   **destination** (string) - Required - The destination IP address or hostname for the domain's email.

### Request Example
`GET /cgi-bin/api?call=api_add_incoming_domain&domain=demo-domain.invalid&destination=mail.demo-domain.invalid`
```

--------------------------------

### Execute Bulk Protection via Command Line (PHP)

Source: https://documentation.n-able.com/spamexperts/userguide/Content/Integration/cpanel-addon-configuration

This command-line utility allows for executing the bulk-protection procedure, designed to handle large domain lists more efficiently than the user interface. It iterates through all local domains (account, add-on, parked) and performs necessary protection tasks. Requires root access to execute.

```bash
cd /usr/local/prospamfilter
php bin/bulkprotect.php
```
Tokens:
Raw