This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
howtos:macosx [2008/07/05 14:51] – amatubu | howtos:macosx [2015/04/11 10:07] – amatubu | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Using POPFile on Mac OS X Platforms | + | ====== Using POPFile on Mac OS X Platforms ====== |
- | POPFile v1.1.0 comes with the first official Mac OS X installer! You can now install POPFile on your Mac easily. | + | POPFile v1.1.0 comes with the first official Mac OS X installer! You can now install POPFile on your Mac easily. **POPFile v1.1.3 is compatible with Mac OS X 10.10 (Yosemite)**. |
===== System Requirements ===== | ===== System Requirements ===== | ||
Line 9: | Line 9: | ||
* Mac OS X 10.3.9 or later. | * Mac OS X 10.3.9 or later. | ||
- | * The [[/ | + | * The [[/ |
* An e-mail account that uses the POP3 protocol (most accounts do, although you can't use POPFile with web-based services like Hotmail and Yahoo! Mail without extra software. See [[:HowTos | Configuring Proxies & Firewalls]]). | * An e-mail account that uses the POP3 protocol (most accounts do, although you can't use POPFile with web-based services like Hotmail and Yahoo! Mail without extra software. See [[:HowTos | Configuring Proxies & Firewalls]]). | ||
- | * Approximately | + | * Approximately |
- | * POPFile itself occupies about 4MB. | + | * POPFile itself occupies about 3.8MB. |
- | * POPFile is written in Perl and requires some extra Perl modules so the installer installs the modules which occupies approximately | + | * POPFile is written in Perl and requires some extra Perl modules so the installer installs the modules which occupies approximately |
- | * The installer installs the ' | + | * The installer installs the ' |
* The installer also installs XMLRPC module, NNTP/SMTP proxies and IMAP module. | * The installer also installs XMLRPC module, NNTP/SMTP proxies and IMAP module. | ||
- | * If you need the optional | + | * The SSL Support |
* The word lists (called the corpus) used to classify your email will take some additional space depending on how much mail you use to train POPFile and how many buckets you create. POPFile keeps a temporary copy of recent mail (the Message History) for a few days to make it easy to correct any classification errors so some extra space is required for these recent messages. For some users only a few extra MB will be sufficient for the corpus and Message History, for others an additional 100 MB may be required. | * The word lists (called the corpus) used to classify your email will take some additional space depending on how much mail you use to train POPFile and how many buckets you create. POPFile keeps a temporary copy of recent mail (the Message History) for a few days to make it easy to correct any classification errors so some extra space is required for these recent messages. For some users only a few extra MB will be sufficient for the corpus and Message History, for others an additional 100 MB may be required. | ||
Line 29: | Line 29: | ||
===== Installation ===== | ===== Installation ===== | ||
- | - Download the Mac OS X installer from the [[/ | + | - Download the Mac OS X installer from the [[/ |
- Run // | - Run // | ||
- POPFile will be installed in ''/ | - POPFile will be installed in ''/ | ||
- | - Configura | + | - Configure |
- Configure your email client. See [[:HowTos | Configuring Specific Mail Clients]]. | - Configure your email client. See [[:HowTos | Configuring Specific Mail Clients]]. | ||
Line 45: | Line 45: | ||
===== Utility scripts included in the installer package ===== | ===== Utility scripts included in the installer package ===== | ||
- | The installer package includes several utility scripts written in AppleScript. You can copy them to your hard drive. | + | The installer package includes several utility scripts written in %%AppleScript%%. You can copy them to your hard drive. |
* start-popfile - Launch POPFile (in background). Requires root privilege. | * start-popfile - Launch POPFile (in background). Requires root privilege. | ||
Line 55: | Line 55: | ||
* start-popfile-with-console - Lanuch POPFile in the Terminal.app. Useful for debugging. | * start-popfile-with-console - Lanuch POPFile in the Terminal.app. Useful for debugging. | ||
+ | * custom-data-folder - Choose custom data folder and run POPFile using the chosen data folder. | ||
- | ====== Installing POPfile MANUALLY on Mac OS X 10.4.x (Tiger) ====== | + | * uninstall-popfile - Remove POPFile program and data files (corpus and configuration files) from your Mac. |
- | This procedure shows you how to install POPfile on Mac OS X 10.4.x systems, and how to create a startup item that will start POPfile each time you reboot the system. | + | ===== Uninstalling ===== |
+ | |||
+ | - Run the ' | ||
+ | |||
+ | ====== Installing POPfile MANUALLY on Mac OS X 10.4.x (Tiger) or later ====== | ||
+ | |||
+ | This procedure shows you how to install POPfile on Mac OS X 10.4.x | ||
As of Mac OS X 10.4, Mac OS X comes with Perl and SQLite3 installed. So you'll simply need to install Xcode, a few Perl library packages, and a startup item. | As of Mac OS X 10.4, Mac OS X comes with Perl and SQLite3 installed. So you'll simply need to install Xcode, a few Perl library packages, and a startup item. | ||
- | At the time of this writing (January 2007), POPfile does not fully support SQLite3. On Mac OS X 10.4.x systems, POPfile requires the SQLite2 Perl package, DBD:: | + | To run POPfile in Mac OS X 10.4.x |
* Apple' | * Apple' | ||
* Perl library packages — that POPfile uses to classify email | * Perl library packages — that POPfile uses to classify email | ||
* POPfile startup item — to automatically start POPfile whenever you restart your computer | * POPfile startup item — to automatically start POPfile whenever you restart your computer | ||
- | * SQLite version 2 command-line tool (Optional) — an external tool you may use to de-fragment or verify the integrity of your POPfile database | ||
**Note**: Because setting up CPAN, a Perl package manager, or Fink, another package manager, on a virgin system can complicate matters, we'll stick with the source and do it the old-school way to avoid complications. | **Note**: Because setting up CPAN, a Perl package manager, or Fink, another package manager, on a virgin system can complicate matters, we'll stick with the source and do it the old-school way to avoid complications. | ||
Line 74: | Line 80: | ||
**TIP**: On the command line, %%~%% means "your home directory" | **TIP**: On the command line, %%~%% means "your home directory" | ||
- | |||
- | **Note**: An alternative set of instructions is available [[http:// | ||
===== Step By Step Instructions ===== | ===== Step By Step Instructions ===== | ||
Line 87: | Line 91: | ||
- Download the cross-platform version of POPFile from here: [[http:// | - Download the cross-platform version of POPFile from here: [[http:// | ||
- Download these Perl library packages (from the [[http:// | - Download these Perl library packages (from the [[http:// | ||
- | * Date::Parse - part of [[http:// | + | * Date::Parse - part of [[http:// |
- | * Date:: | + | * Date:: |
- | * HTML:: | + | * HTML:: |
- | * DBI - [[http:// | + | * DBI - [[http:// |
- | * DBD:: | + | * DBD:: |
- | * MIME::Base64 | + | * DBD::SQLite |
- | * HTML:: | + | * HTML:: |
- | * HTML:: | + | * HTML:: |
+ | * Net:: | ||
+ | * IO:: | ||
+ | * SOAP::Lite - [[http:// | ||
+ | * IO:: | ||
- Install each of the Perl library packages you downloaded in the previous step: | - Install each of the Perl library packages you downloaded in the previous step: | ||
- Open a terminal window if one is not already open. | - Open a terminal window if one is not already open. | ||
Line 118: | Line 126: | ||
- Open a terminal window if one is not already open. | - Open a terminal window if one is not already open. | ||
- Enter the command to change the working directory to the ~/ | - Enter the command to change the working directory to the ~/ | ||
- | - Enter the command to start POPfile manually: < | + | - Enter the command to start POPfile manually: < |
- | - Watch the output in the terminal. If POPfile is installed properly, you should not see any errors. \\ **Note:** If you start POPfile and it outputs an error starting out with something like: Can't locate DBD/ | + | - Watch the output in the terminal. If POPfile is installed properly, you should not see any errors. \\ **Note:** If you start POPfile and it outputs an error starting out with something like: Can't locate DBD/ |
+ | listen port 110. This could be because there is another service | ||
+ | using that port or because you do not have the right privileges on | ||
+ | your system (On Unix systems this can happen if you are not root | ||
+ | and the port you specified is less than 1024). </ | ||
+ | |||
- Type Control-C into the terminal window to stop POPfile and exit to the command prompt. | - Type Control-C into the terminal window to stop POPfile and exit to the command prompt. | ||
Line 127: | Line 141: | ||
+ | ==== Creating a POPfile Startup Item for Mac OS X 10.10 (Yosemite) ==== | ||
+ | - Create the Mac OS X POPFile < | ||
+ | - Create a plain text file named %%" | ||
+ | < | ||
+ | <plist version=" | ||
+ | < | ||
+ | < | ||
+ | <false /> | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | <false /> | ||
+ | < | ||
+ | <true /> | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | - In a terminal window, enter these commands: < | ||
+ | sudo chown root:wheel popfile.plist | ||
+ | sudo chmod 644 popfile.plist | ||
+ | sudo launchctl load / | ||
+ | </ | ||
+ | - Finally, to start up POPFile without rebooting enter this terminal command: < | ||
- | ==== Creating a POPfile Startup Item for Mac OS X ==== | + | ==== Creating a POPfile Startup Item for Mac OS X 10.9 (Mavericks or before) |
**NOTE**: You should be logged into an administrator account for this procedure. | **NOTE**: You should be logged into an administrator account for this procedure. | ||
- Create the Mac OS X POPfile startup item: | - Create the Mac OS X POPfile startup item: | ||
- | - Enter this command to create the folder / | + | - Enter this command to create the folder |
- | - Create a plain text file named " | + | - Create a plain text file named %%" |
Description = " | Description = " | ||
Provides = (" | Provides = (" | ||
Line 147: | Line 211: | ||
}; | }; | ||
}</ | }</ | ||
- | - Create a plain text file named " | + | - Create a plain text file named " |
#!/bin/sh | #!/bin/sh | ||
# | # | ||
Line 156: | Line 220: | ||
. / | . / | ||
- | PFPATH='/ | + | PFPATH='/ |
if [ " | if [ " | ||
then | then | ||
- | pid=$( ps -auxww | grep popfile.pl | grep -v grep | awk '{ print $2 }' ) | + | pid=$( ps -axww | grep popfile.pl | grep -v grep | awk '{ print $1 }' ) |
if ! [ $pid ]; then | if ! [ $pid ]; then | ||
ConsoleMessage " | ConsoleMessage " | ||
cd " | cd " | ||
perl popfile.pl > /dev/null 2>&1 & | perl popfile.pl > /dev/null 2>&1 & | ||
+ | |||
fi | fi | ||
elif [ " | elif [ " | ||
then | then | ||
- | pid=$( ps -auxww | grep popfile.pl | grep -v grep | awk '{ print $2 }' ) | + | pid=$( ps -axww | grep popfile.pl | grep -v grep | awk '{ print $1 }' ) |
if [ $pid ]; then | if [ $pid ]; then | ||
ConsoleMessage " | ConsoleMessage " | ||
Line 177: | Line 242: | ||
elif [ " | elif [ " | ||
then | then | ||
- | pid=$( ps -auxww | grep popfile.pl | grep -v grep | awk '{ print $2 }' ) | + | pid=$( ps -axww | grep popfile.pl | grep -v grep | awk '{ print $1 }' ) |
ConsoleMessage " | ConsoleMessage " | ||
kill -6 $pid | kill -6 $pid | ||
Line 205: | Line 270: | ||
Localizable.strings</ | Localizable.strings</ | ||
- In a terminal window, enter these commands: < | - In a terminal window, enter these commands: < | ||
- | sudo chown -R root.admin popfile | + | sudo chown -R root:wheel POPfile |
- | cd popfile | + | cd POPfile |
- | sudo chmod 754 popfile | + | sudo chmod 754 POPfile |
sudo chmod 644 StartupParameters.plist</ | sudo chmod 644 StartupParameters.plist</ | ||
- Finally, to start up POPFile without rebooting enter this terminal command: < | - Finally, to start up POPFile without rebooting enter this terminal command: < |
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.