INSTALLATION NOTES

 

Summary :

Windows users :

Installation - Windows
Compilation - Windows (this step is not necessary but could be important if you want change some features yourself)

Configuration of Spaxy
Using Spaxy
Configuration of email client - Outlook Express (for configuring the port then the message rules)

Linux/Unix users :

Installation / Compilation - Linux
Configuration of Spaxy
Using Spaxy
Configuration of email client - Netscape Navigator

Installation - Windows

1 - Install Qt

1.1 - Go here and download the latest version of Qt for Windows. You have the choice of an evaluation version (during 30 days) or a non-commercial version but it is older. Prefer the evaluation version.
1.2 - Install Qt by following the instructions. You will have Qt DLL in the system directory.

2 - Install Spaxy

2.1 Go here and download the latest version of Spaxy for Windows (win32).
2.2 Dezip the files in a folder then launch qtspaxy.exe
2.3 It's all ! Now you are ready for the configuration !

 

 

Installation / Compilation - Linux

1 - Install Qt

1.1 - Go here and download the latest version of Qt for X11. For Linux users, the latest version is free for non-commercial use.

1.2 - You must be logged as root to install Qt. Follow something approaching these instructions :

$ su
$ cd /usr/lib
$ mv qt qt-old
$ bzip2 -dc qt-x11-free-???.tar.bz2 | tar -xvf-
$ ln -sf qt-x11-free-3.1.1 qt


1.3 - Install Qt by following the instructions in ./qt/INSTALL. Don't forget to update your .login file for the environment variables and compile the Qt library using configure and make (this can be during a while).

2 - Compile Spaxy

2.1 Go here and download the latest sources of Spaxy for Linux (src).

2.2 Dezip the files in a folder and compile Spaxy :

$ qmake
$ make
$ ./qtspaxy

2.3 It's all ! Now you are ready for the configuration !

 

Configuration of Spaxy

1 - Set up the proxy

1.1 - When you launch Spaxy, it tries to connect and wait on the port 110, the default port for common POP servers. If you are a Linux user and are not root or if you don't want to use the port 110, you should change that in the configuration file. Edit ./config/config.cfg

1.2 - In this file, each line can be a parameter definition (begin with '$') or a comment (begin with '#'). The syntax of parameters definition is very simple but you must respect it. Syntax is :

$parameter_name = "parameter_value"

The first parameters (spaxy_version, spaxy_date, ...) are not important and are provided for information only. You can change theses parameters :

Parameters Default value Purpose
port_client
110
Default port for waiting email clients. Put 1100 if you are not root.
port_server
110
Default port for POP servers if not given by the email clients. You should not modify this value.
max_connect
10
Maximum limit for clients connection. Lower this value if you have just one account or if the client do not do parallel email retrieving. Increase this value if you want to allow online POP filter service for other users. Note that it is not recommended because of security reasons (password is not encrypted).

 

2 - Set up the rules

2.1 - Now you have to give some intelligence to your filter. In default settings, the SPAM detector is not activated, i.e. the mail pass into the filter without be changed in anything. If you want the filter catch the SPAM emails, you must configure the filter rules. Spaxy is based on a scoring method. A set of rules is applied on the incoming email and decide how much it is SPAM. Each time a rule is activated, a constant value is added to the email. At the end, if the note of the email exceed a fixed limit, it is considered as SPAM. A SPAM email is marked by adding a spam-mark at the beginning of the subject and a normal email (called it 'HAM') is not altered and it pass the filter as if there were no filter. Now you are ready to configure the following parameters :
Parameters Default value Purpose
spam_limit
10
This is the SPAM limit. If the finale note is egal or superior to spam_limit, it is considered as SPAM.
spam_mark
"**SPAM** "
This is the mark in the subject for SPAM detection by the email client. It must be configured to stop email with that marking. It this line is in comment (begin with '#'), the filter is desactivated (all the emails are considered as HAM). Note the space after the mark.
spam_word
"SEX123"
This parameter are provided for immediate test. If this word is in the subject, the email is considered as SPAM. This test is case-sensitive. By default, the line is in comment, i.e. test is not activated.
backup_mode
0
Set this value at 1 for saving all incoming emails on the hard disk, in the same folder as Spaxy. The name of the emails are selected randomly.

2.2 - After the parameters, each line describes a rule. The syntax is :
note rule
The note can be positive or negative but must be an integer (only rounded value, not 0.51 for example). The format of the rule is very simple and powerful and is described in the section of the rules. You can add as many rules as you want, only by adding a new line. In the default config file, some rules have been already put :
+1 {subject:free|credit}&{from:hotmail@}
Increase the note by 1 if the subject contains "free" or "credit" and the email come from hotmail (from adress contains "hotmail@").

+1 {body:unsubscribe|click|sex}
Increase the note by 1 if the body of the message contains "unsubscribe" or "click" or "sex".

-1 {from:my-friend@domain.com}
Decrease the note by 1 if the email comes from the specified adress.

-1 {to|cc:my-adress@domain.com}
Decrease the note by 1 if the email is adressed (directly or by carbon copy) to the specified adress.
As you can see, the rule can be very powerful and many rules can be combined between them. See the section of the rules for more interesting rules.

 

Using Spaxy

If you have pass with sucess installation and configuration of Spaxy, then you can launch it !

The Spaxy panel is divided in three panels. The first one control the state of the proxy. Click "Run" to launch it (then it waits email clients on the configured port) and "Stop" to stop it !

The second panel is like that, depending on your system :

In the first row, you can see : number of mails received from Internet, number of mails given as 'HAM' to the client, number of mails given as 'SPAM' to the client. In the second row, you can see the same values, but in bytes. In the last row, you can see the number of connexions on a POP server, the number of connexions of your email client and the number of connexion errors (server does not exist any more, ...).

The third panel let you select the configuration file. You can have as many configurations as you want, simply copy an other config file in the same folder (./config), rename it and edit it. Then click "Refresh" for refresh the content of the config folder and select the new config file. For loading the new configuration, you must stop and run the proxy again. Be careful that client is not in state of emails retrieving.