This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
experimentalmodules:imapinstructions [2007/01/24 09:39] – sbernheart | experimentalmodules:imapinstructions [2016/10/02 14:03] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Getting IMAP.pm up and running ====== | ====== Getting IMAP.pm up and running ====== | ||
- | This page is currently | + | This page is intended to give people willing to use the IMAP module an idea of how to get the module running, how to configure it, and what to expect from it. |
===== What IMAP.pm does (or tries to do) ===== | ===== What IMAP.pm does (or tries to do) ===== | ||
- | IMAP.pm, unlike POPFile' | + | |
+ | ^IMAP.pm, unlike POPFile' | ||
+ | |||
+ | This module connects to your IMAP server and then tries to stay connected as long as POPFile is running. At regular (adjustable) intervals, it will check your IMAP server for new messages. New messages are classified and then moved to other folders on the server based on the bucket the messages were assigned to. | ||
IMAP.pm not only checks for new incoming mail, it also scans its output folders for mail that you moved there. For example, if you have created IMAP folders " | IMAP.pm not only checks for new incoming mail, it also scans its output folders for mail that you moved there. For example, if you have created IMAP folders " | ||
+ | |||
To summarize: | To summarize: | ||
* IMAP.pm will try to classify new messages and move them accordingly | * IMAP.pm will try to classify new messages and move them accordingly | ||
- | * and it will also try to reclassify erroneously classified messages. | + | * and it will also try to reclassify erroneously classified messages |
===== What IMAP.pm (currently? | ===== What IMAP.pm (currently? | ||
+ | |||
* It cannot talk to multiple IMAP servers. | * It cannot talk to multiple IMAP servers. | ||
* It will not modify the subject (according to classification) or add any of the X-POPFile-Link or X-Text-Classification headers to messages. | * It will not modify the subject (according to classification) or add any of the X-POPFile-Link or X-Text-Classification headers to messages. | ||
Line 17: | Line 23: | ||
===== What you need to run IMAP.pm ===== | ===== What you need to run IMAP.pm ===== | ||
- | The IMAP module | + | All you need is a mail client with IMAP capabilities and an IMAP account at your ISP. The rest of the functionality |
- | + | ||
- | If you are not on Windows, you can download the latest version of the IMAP module | + | |
- | + | ||
- | If you are using the cvs version | + | |
- | + | ||
- | Of course, you will also need a mail client with IMAP capabilities and an IMAP account at your ISP. | + | |
===== How to get it running ===== | ===== How to get it running ===== | ||
Line 34: | Line 34: | ||
* shut-down POPFile, | * shut-down POPFile, | ||
* and start it again. | * and start it again. | ||
- | IMAP.pm should now be running along with POPFile. | ||
- | You do not have to make any changes to your mail client configuration to work with POPFile' | + | ^You do not have to make any changes to your mail client configuration to work with POPFile' |
===== Configuring IMAP.pm ===== | ===== Configuring IMAP.pm ===== | ||
- | To configure the module, go to the Configuration tab in the POPFile UI. Before you do that, however, you might want to use your mail client to create folders on your IMAP server that will receive the classified messages. For ex., you might want to create a folder named " | ||
- | First, enter the connection details for your IMAP server, i.e. the server' | + | To configure the module, go to the Configuration tab in the POPFile UI. Before you do that, however, you might want to use your mail client to create folders on your IMAP server that will receive the classified messages. For example, you might want to create a folder named " |
+ | |||
+ | First, enter the connection details for your IMAP server, i.e. the server' | ||
In the next configuration step, you need to tell the module about the IMAP folder that receives incoming messages (usually the INBOX folder), and the output folders where the classified messages should go. You need to use your mail client to create new folders on the server that correspond to your buckets. Click the " | In the next configuration step, you need to tell the module about the IMAP folder that receives incoming messages (usually the INBOX folder), and the output folders where the classified messages should go. You need to use your mail client to create new folders on the server that correspond to your buckets. Click the " | ||
- | Now select a watched folder (default: INBOX) and click the " | + | Now select a watched folder (default: INBOX) and click the " |
- | For each of your buckets, the UI should show a drop-down menu that lets you select an output IMAP server for that bucket. You can redirect the output of one bucket back to your INBOX, so that ham messages will simply stay there, while spam messages get moved to another folder. Click " | + | For each of your buckets, the UI should show a drop-down menu that lets you select an output IMAP server for that bucket. You can redirect the output of one bucket back to your INBOX, so that ham messages will simply stay there, while spam messages get moved to another folder, e.g. Click " |
Line 53: | Line 53: | ||
? Expunge deleted messages | ? Expunge deleted messages | ||
- | ! Check this box if you want IMAP.pm to issue an EXPUNGE command to the IMAP server after it has moved messages out of a folder. Beware -- this will also EXPUNGE messages that you have marked for deletion within your client. | + | ! Check this box if you want IMAP.pm to issue an EXPUNGE command to the IMAP server after it has moved messages out of a folder. Beware -- this will also EXPUNGE messages that you have marked for deletion within your client, but the setting is needed for some IMAP clients that will otherwise simply show you the deleted, but not yet expunged, messages. |
? Update interval | ? Update interval | ||
- | ! Enter the number of seconds between status updates. How often should IMAP.pm check your mailbox? | + | ! Enter the number of seconds between status updates. How often should IMAP.pm check your mailbox? |
- | ? Bytes to use per message | + | |
- | ! The number of bytes/ | + | |
- | ? Debug level | + | |
- | ! In the latest versions on cvs there is no longer an IMAP specific debug level. POPFile now has a global debug level that can be changed via the Advanced Tab -- change the variable " | + | |
Clicking on " | Clicking on " | ||
+ | |||
+ | |||
+ | |||
===== Reporting bugs ===== | ===== Reporting bugs ===== | ||
- | If you find any bugs (or have any questions), go to the [[http://sourceforge.net/ | + | |
+ | If you find any bugs (or have any questions), go to the [[/discussion/3| Bleeding Edge - Source code forum]], look for the latest thread about IMAP (or start a new one) and provide as many details as you can. However, this is not to say that you should post megabytes worth of log files. | ||
===== Links ===== | ===== Links ===== | ||
+ | |||
We have started a [[ExperimentalModules: | We have started a [[ExperimentalModules: | ||
If you would like to know about the proposed future of the POPFile IMAP module, checkout the [[ExperimentalModules: | If you would like to know about the proposed future of the POPFile IMAP module, checkout the [[ExperimentalModules: | ||
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.