Unpack the zipfile, copy the files ending .hsc to your Hamster script directory and the files ending .hsm to your hamster modul directory. If you have a Hamster newer the 2.0.0.1 you can open the two .hsc files and uncomment the very first line (just remove the first # (only the first)).
The name which gets written in the toolbar is german. You can change it without problems to an english expression. Eg.
could be changed (and the # removed) to:
This will enable Hamster to create new entries in the toolbar under the point Tools.
Then choose from the menubar File -> Refresh menu items. Now you should have two (new) entries in the menubar in the Tools menu like eg.:
- Konfiguriere Filterstatistik
- Erstelle Filterstatistik
After a spam account has been created (cf point (1) under What should be known below) just choose the second entry.
It writes a statistics about your filterrules. Which rule did how often match and when had the last match been.
Example:
1 x kill() Filter-7 # Kommentar Last Match: 02-03-25 3 x kill() Filter-4 Last Match: 02-04-24 . . 13 x kill() Filter-2 Last Match: 02-05-29 4 x ignore() Filter-1 Last Match: 02-04-13 . . 13 x ignore() Filter-5 Last Match: 02-05-25
An explaination of what has been done is also written in the mail and the saved file (yymmddhhnn_matchlist.txt)
A copy of your mailFilt.hst is written where each rule is marked with the frequency it appeares in the notify mails. So it helps finding not used rules.
Example:
[*] notify(admin,spam) 4 x ignore() Filter-1 13 x kill() Filter-2 0 x kill() Filter-3 [Abschnitt-A] # Kommentar 3 x kill() Filter-4 13 x ignore() Filter-5 # Kommentar 0 x ignore() Filter-6 1 x kill() Filter-7 # Kommentar . .
That copy is also saved in a file; default name is yymmddhhnn_mailfilthst.txt
The notifymails from hamster have to be sent to (another) user named spam. Had the mails been sent only to admin eg.
The name of the user spam can be set with the variable $ks_accountname If HamMailPath\$ks_accountname does not exist the script stops.
The default for that variable is (in killsstatdialog.hsm)
- varset($ks_accountname, "spam")
Naturally you have to create that user before you can send him any mail. You shouldn't use a client to retrieve mails for that user. If that has to be done anyway be sure, the mails aren't deleted after you fetched them through pop3. Deleted mails can't be used for statistics.
The results are saved in textfiles in a directory which is defined in the variable
with the default value
If HamPath\$ks_resultpath does not exist the script the script tries to create the directory.
The results are also sent to a user. The address of the user must be set with the constant
(default is admin).
The notifymails are automagically removed. Removing depends on their age and the length of storing depends on the variable $ks_storetime. The default is
(duration in days).
If the statistics are to be sent as mail if they should be saved, whether the notifymails are automagically removed or the statistics are shown in the log can be set with these four variables:
These are their default values.
The language can be set in the modul killsstatdialog.hsm. German and English are supported.
The values are "de" or "en". Any other value except 0 defaults to english. Zero or no value starts a new dialog asking for the language.
As default the emails originating from the script contain a long explaination describing mutants (differences in between the way filter lines are written in a notify mail and the filter file). That explaination can be turned off with the variable
(in the dialog). The default is true which means to insert the explaination. In the dialog you have to enter a 1 for true and 0 (zero) for false.
In newer Hamster versions (>= 2.0.1.3) mutants should no longer be a problem.
If you would like to change the values without aid you must edit the file killsstatdialog.hsm. If not, the first time you start the script a small konfiguration script will start which allows you to easily set the approbiate values.
Later changes can be made by starting that script from the menubar under Tools -> Konfiguriere Filterstatistik (sorry for the german name this will perhaps change in the future).
Naturally this is only true if you have a Hamster newer than 2.0.0.1 and if you removed the comment sign as explained in Short Start.
These values are stored in the file hscripts.ini in the section Killsstats.
The script can be started from the menubar under Tools -> Erstelle Filterstatistik (or under the name you gave the menu entry).
Have much fun and never forget: spammers are