Welcome to POPFile v1.0.0 POPFile is an email classification tool with a Naive Bayes classifier, POP3, SMTP, NNTP proxies and IMAP filter and a web interface. It runs on most platforms and with most email clients. This version is a bug fix and minor feature release. It's also the first release to have the version number 1. This is because we've finally decided to stop pretending that POPFile is 'beta' software :-) WHAT'S CHANGED SINCE v0.22.5 1. Changes to the IMAP module / Support for Gmail IMAP The IMAP module will now use only one connection to the IMAP server, instead of one connection for each watched folder. This means that when using IMAP mode, POPFile will be much lighter on the server and will even work with IMAP servers that are restrictively configured or if you have many buckets. As a consequence, you should now be able to let POPFile sort your email on Google's Gmail. Please refer to the setup instructions on the POPFile wiki: http://getpopfile.org/wiki/experimentalmodules:imapinstructions 2. Nihongo improvements Japanese (Nihongo) text does not use spaces between words so POPFile uses a 'Nihongo Parser' to split the text into words to allow the text to be analysed properly. Up until now POPFile has used the 'Kakasi' parser when analysing Japanese text. The 1.0.0 release offers a choice of three parsers (Kakasi, MeCab and internal). The new 'bayes_nihongo_parser' configuration parameter is used to specify the parser to be used (the default parser is Kakasi). The Windows installer lets the user select the Nihongo parser to be installed. All of the files needed for the Kakasi and internal parsers are included in the installer. The MeCab package size is about 13 MB (i.e. too big to include in the installer) so it will be downloaded from the Internet if the MeCab parser is selected when installing POPFile. Other Nihongo changes: fixed a bug that the history table in the UI was not being shown correctly when invalid characters were used in the From, To and Cc headers in Nihongo mode; fixed a bug in the shortening of Subjects in the history table. 3. Installer improvements To make it easier to add SSL support after installing POPFile the installer now creates an "Add/Remove Programs" entry which allows SSL support to be added by downloading and installing the necessary support files. This entry also allows the Nihongo parser to be changed and will download the MeCab package if necessary. The installer and uninstaller have been upgraded to work better when used on Vista, especially when run from a standard user account. Many of these improvements also apply to Windows XP. For example the uninstaller is now less likely to leave Start Menu shortcuts behind. 4. UI improvements Change the default skin choice to simplyblue. Add two new skins, coolmint and ocean. Drop less popular skins: klingon, prjbluegrey, and prjsteelbeach. Merge nearly duplicate tinydefault and lrclaptop with smalldefault. Add a little bit of polish to many of the others. Add a JavaScript Check All box for selecting messages to remove from history. 5. Other improvements Performance improvement in analyzing e-mails. Encoded attachment file names are now decoded. Fixed a bug that missed some e-mail addresses. WHERE TO DOWNLOAD http://getpopfile.org/wiki/download GETTING STARTED WITH POPFILE An introduction to installing and using POPFile can be found in the QuickStart guide: http://getpopfile.org/wiki/QuickStart SSL SUPPORT IN WINDOWS SSL Support is offered as one of the optional components by the installer. If the SSL Support option is selected the installer will download the necessary files during installation. If SSL support is not selected when installing (or upgrading) POPFile or if the installer was unable to download all of the SSL files then POPFile's "Add/Remove Programs" entry can be used to add SSL support to an existing installation. I AM USING THE CROSS PLATFORM VERSION POPFile requires a number of Perl modules that are available from CPAN. You will need: Date::Parse HTML::Template HTML::Tagset DBD::SQLite2 DBI TimeDate You can install all the required POPFile modules by getting the Bundle::POPFile bundle from CPAN. Please refer to the installation instructions on the POPFile wiki: http://getpopfile.org/wiki/HowTos:CrossPlatformInstall Japanese users may need to install some extra programs and Perl modules, depending upon which Nihongo parser (wakachi-gaki program) they wish to use. For more information about how to install them, see the POPFile wiki: http://getpopfile.org/wiki/JP:HowTos:CrossPlatformInstall CROSS PLATFORM VERSION KNOWN ISSUES The current version of SQLite (v3.x) is not compatible with POPFile. You must use DBD:SQLite2 to access the database. Users of SSL on non-Windows platforms should NOT use IO::Socket::SSL v0.97 or v0.99. They are known to be incompatible with POPFile; v1.07 is the most recent release of IO::Socket::SSL that works correctly. WINDOWS KNOWN ISSUES 1. THE TRAYICON ON WINDOWS CAN CAUSE POPFILE TO FREEZE. With certain setups, if you attempt to view the trayicon's tooltip or hover your cursor over it while checking or downloading mail POPFile may freeze. The exact cause is still unknown but it may be related to some video drivers. If this problem affects you turn off the trayicon. Due to this issue, we suggest users of the IMAP module disable the trayicon since a freeze may go unnoticed more easily than when using a mail client to make POP3 connections. 2. ON WINDOWS I WANT TO CHECK MULTIPLE EMAIL ACCOUNTS SIMULTANEOUSLY. Because the time taken to start a new process on Windows is long under Perl there is an optimization for Windows that is present by default: when a new connection is made between your email program and POPFile, POPFile handles it in the 'parent' process. This means the connect happens fast and mail starts downloading very quickly, but is means that you can only downloaded messages from one server at a time (up to 6 other connections will be queued up and dealt with in the order they arrive) and the UI is unavailable while downloading email. You can turn this behavior off (and get simultaneous UI/email access and as many email connections as you like) on the Configuration panel in the UI and making sure that "Allow concurrent POP3 connections:" is Yes, or by specifying --set pop3_force_fork=1 on the command line. The default behaviour (no concurrent POP3 connections) can cause email clients to time out if several accounts are being checked (because POPFile only handles one account at a time it can take a while to process all of the accounts). If SSL support is being used then the default setting (no concurrent POP3 connections) _MUST_ be used otherwise POPFile crashes. v0.22.0 RELEASE NOTES If you are upgrading from pre-v0.22.0 please read the v0.22.0 release notes for much more information: http://getpopfile.org/wiki/ReleaseNotes DONATIONS Thank you to everyone who has clicked the Donate! button and donated their hard earned cash to me in support of POPFile. Thank you also to the people who have contributed their time through patches, feature requests, bug reports, user support and translations. http://sourceforge.net/forum/forum.php?forum_id=213876 THANKS Big thanks to all who've contributed to POPFile. John.
Should you find anything in the documentation that is incomplete, unclear, outdated or just plain wrong, please let us know and leave a note in the Documentation Forum.