This utility is deprecated and no longer supported. It will not function properly with versions higher than 0.20.x.
The POPFile diagnostic utility is a tool to check the configuration parameters and installation files for a POPFile install. It attempts to detect problems with the installation that may prevent POPFile from operating properly.
This version has been tested in a Windows environment with versions 0.18.1 and 0.19.0 of POPFile. The author believes that the utility is platform independent and will work properly on non-Windows POPFile installs, but has not tested on those platforms.
POPFile is an automatic email classification tool authored by John Graham-Cumming available from SourceForge.
Download the script to your POPFile install directory, normally c:\Program Files\Popfile by clicking here.
Open a DOS Command box (click the DOS icon on your desktop or Start/Run and type command in the open box and click ok).
Change to your POPFile installation directory, e.g.,
cd "\program files\popfile"
Run pfdiagnose.pl using Perl.
perl pfdiagnose.pl > report.txt
The resulting diagnostic report will be in the file named 'report.txt', open it with a text editor such as notepad.
start notepad.exe report.txt
pfdiagnose performs the following diagnostic checks of your POPFile installation.
That you have a popfile.cfg configuration file that exists and is not marked read-only.
That your popfile.cfg entries occur only once per entry type, e.g., no duplicates.
That your configured corpus directory exists and contains buckets.
That your corpus table exists and is not marked read-only.
That each entry in your corpus table is formatted properly, e.g., a single line per entry where the 'word' is single space separated from the integer word count and the 'word' contains no leading or embedded spaces.
That your corpus params file exists and is not marked read-only.
That your optional corpus color file, if present, is not marked read-only.
That your optional corpus magnet file, if present, is not marked read-only.
That any magnet entries do not have leading or trailing spaces.
That any magnet entries have a valid type of From, To, CC , or Subject.
That your configured POP3 port can be openned successfully.
That the values of numerous configuration parameters and ports are valid and are within valid ranges.
That your configured message directory exists.
That all msg and cls files in your message directory are not marked read-only.
That each msg file has a corresponding cls file.
Windows users who have Tim Charron's Blat utility can easily set up pfdiagnose to run automatically and email the results.
Obtain and install Blat from Tim Charron's page here.
install Blat in a directory in your path, or the POPFile directory
run Blat -install <server address> <senders address> to get Blat configured correctly. Make sure that <server address> points to an smtp server that you are permitted to relay mail thru, usually this will be the same smtp server you set up in your mail client.
Create a batch file as follows:
perl pfdiagnose.pl | blat - -t youremail@address.here -s "POPFile Diagnostic Report" cls @exit
Save the batch file in your POPFile directory, name it pfdiagnose.bat
Use the Wizard to browse to your POPFile installation directory, usually "c:\Program Files\Popfile", and select the batch file pfdiagnose.bat
change the name of the task to POPFile Diagnostics
Select the frequency to run it
Select the time and day(s) to run it
Click finish
Close the task scheduler (or test it by right clicking on the new entry you made and selecting run)
You're done. The task scheduler will run the batch file at the time(s) you scheduled. The batch file will run the diagnostic report and email it off to you. No muss, no fuss <g>
Copyright (C) 2003 Scott W. Leighton
Licensed under the terms of the GNU General Public License.
Contributed to the POPFile project under the terms of the POPFile License Agreement.