| 1 | Mail Fetch -- Version 1.3.0 |
| 2 | |
| 3 | Downloads mail from a pop3 server to your SquirrelMail account. |
| 4 | |
| 5 | Features |
| 6 | ======== |
| 7 | |
| 8 | * Copies messages from remote server |
| 9 | * Saves server, alias, username, and password in prefs file... |
| 10 | * Remembers where to resume downloading messages if |
| 11 | your pop server supports UIDL. |
| 12 | * Optionally deletes mail from the remote server. |
| 13 | * Allow an infinite amount of remote servers |
| 14 | * Optional to not save password - prompt on check |
| 15 | * Save messages into a local IMAP folder instead of INBOX |
| 16 | * Check mail during login (Needs SM 1.1.3 or older). |
| 17 | * Check mail during folder refreshes. |
| 18 | * Allows gettext translations. |
| 19 | |
| 20 | |
| 21 | Description |
| 22 | =========== |
| 23 | |
| 24 | Feel like grabbing your messages from a different mail server into |
| 25 | SquirrelMail? This might be able to help. |
| 26 | |
| 27 | |
| 28 | Configuration |
| 29 | ============= |
| 30 | |
| 31 | Under the options you can add, delete or modify server list where |
| 32 | fetching mail. For each server you can set also username and password; |
| 33 | if you leave password blank, the password whore required when you fetch |
| 34 | mail. Make sure "Leave Mail On Server" is checked if you do not want |
| 35 | Mail_Fetch to delete it from the remote server. Once configured, |
| 36 | click 'Fetch' in the SquirrelMail menu to get your mail; you can fetch |
| 37 | mail from all server instead or from only one by selecting the options |
| 38 | dispayed. |
| 39 | |
| 40 | If you want to check mail periodicaly choose "Check mail during login" |
| 41 | or "Check mail during folder refresh". Of course passwords have to be |
| 42 | entered in order for this to work. |
| 43 | |
| 44 | In order to secure a little bit the system, pop3 passwords can be encrypted. |
| 45 | The encryption key may be defined in to places. The first, and more secure, |
| 46 | is in the httpd configuration as an enviromental variable called MF_TIT |
| 47 | only accesible from the squirrelmail directory. |
| 48 | |
| 49 | the way you can do this from apache is adding the following directives to |
| 50 | httpd.conf (supposing that squirrelmail is located at /usr/local) or an |
| 51 | included configuration file: |
| 52 | |
| 53 | <Directory "/usr/local/squirrelmail"> |
| 54 | SetEnv MF_TIT "MailFetch Secure for SquirrelMail 1.x" |
| 55 | </Directory> |
| 56 | |
| 57 | Of course, you should replace the text inside double quotes with the key |
| 58 | you want to (some kind of secret text). A please remember that the file |
| 59 | where you decided to place this must be root only readable. |
| 60 | |
| 61 | The second way is to edit functions.php and look for: |
| 62 | |
| 63 | if( !isset( $MF_TIT ) ) { |
| 64 | $MF_TIT = "MailFetch Secure for SquirrelMail 1.x"; |
| 65 | } |
| 66 | |
| 67 | Once again change the text "MailFetch 0.8 Secure for SquirrelMail 1.x" |
| 68 | with a secret text. |
| 69 | |
| 70 | Please note that you must redefine passwords each time you change the key. |
| 71 | |
| 72 | To maintain compatibilty with older systems, mail_fetch can work with old |
| 73 | pref files, with no encrypted passwords. If this occurs, you'll see that |
| 74 | the "Encrypt Password" checkbox in the option page is not checked. If you |
| 75 | reenter account's passwords the system will switch to encrypted mode. |
| 76 | |
| 77 | |
| 78 | Future Work |
| 79 | =========== |
| 80 | |
| 81 | * Add IMAP server stealing |
| 82 | |
| 83 | * Limit number of pop accounts |
| 84 | |
| 85 | |
| 86 | Installation |
| 87 | ============ |
| 88 | |
| 89 | As with other plugins, just uncompress the archive in the plugins |
| 90 | directory, go back to the main directory, run configure and add the plugin. |
| 91 | |
| 92 | Questions/comments/flames/etc can be sent to the SquirrelMail plugins list. |
| 93 | |
| 94 | Old versionn (0.7) has been updated from 0.6 by Philippe Mingo <mingo@rotedic.com> |
| 95 | IMPORTANT!!! This is a "secured" version, it makes a little encryption |
| 96 | of the pop3 passwords. In order to use this facility, systems that |
| 97 | have been using older versions (0.6 and lessers) should reenter |
| 98 | passwords using the modify button at the options page in order to |
| 99 | encrypt the password. The Encrypt passwords checkbox is only informative, |
| 100 | and it lets you know if passwords are secure or not. |
| 101 | |
| 102 | Old version (0.4) has been updated from Joshua's version 0.3 by |
| 103 | Tomaso Minelli <minni@minnata.net> |
| 104 | and Tyler (but only VERY minor stuff -- not worth really mentioning) |
| 105 | |
| 106 | Old version (0.3) has been updated from Tyler's original version 0.1 by |
| 107 | Joshua Pollak <pardsbane@offthehill.org> |
| 108 | |
| 109 | |
| 110 | Translations |
| 111 | ============ |
| 112 | Translation is made in the same manner than Squirrelmail's core does. |
| 113 | You need to take <plugin_name>.po file, fill the template, store it |
| 114 | in the appropriate locale folder under the plugin and compile the po |
| 115 | file. Better than this fill the po file and send it back to the author. |
| 116 | The translation will be included in the next release of the plugin. |
| 117 | |
| 118 | |
| 119 | Note for mod_gzip users |
| 120 | ======================= |
| 121 | |
| 122 | As fetching module shows information while fetching is taking place, it |
| 123 | is a good idea to disable compression for that operation. The way to do |
| 124 | this with mod_gzip is: |
| 125 | |
| 126 | mod_gzip_item_exclude file fetch.php |
| 127 | |
| 128 | |
| 129 | Note for Newmail Plugin users |
| 130 | ============================= |
| 131 | |
| 132 | In order to Newmail plugin detect new mails during folder refreshes |
| 133 | make sure that Mail_Fetch is listed first that Newmail in the |
| 134 | SM configuration. To do so you only have to remove Newmail plugin |
| 135 | and then add it again. |
| 136 | |
| 137 | |
| 138 | ChangeLog |
| 139 | ========= |
| 140 | |
| 141 | 1.3.1 |
| 142 | |
| 143 | Bugfix |
| 144 | ------ |
| 145 | 1 Delete mail server routine update record not as expected. |
| 146 | The logic is still correct to completed the wanted action, but the order |
| 147 | is not preserved. The last record was to replace the deleted record. |
| 148 | 2. Connection to IMAP server is not terminated at some condition during |
| 149 | appending email and block the program. |
| 150 | |
| 151 | Added features |
| 152 | -------------- |
| 153 | 1. The UIDL now updated to reflect last successfully fetched mail when |
| 154 | fetching mail from server is stopped in the middle. |
| 155 | 2. POP3 connection will be re-established for non-persistent server failure. |
| 156 | |
| 157 | "Chiu Wai Pun" <pun@alumni.ust.hk> |
| 158 | |
| 159 | --------------------------------------------------------------------------- |
| 160 | Philippe Mingo <mingo@rotedic.com> |
| 161 | --------------------------------------------------------------------------- |
| 162 | 1.3.0 Official SM Version - Moved into the SM package. |
| 163 | 1.2.6 BugFix |
| 164 | 1.2.5 Bugfix |
| 165 | 1.2.4 Optimized class.POP3. Fixed problem with spaces in folders name. |
| 166 | 1.2.3 non-gettext systems now works |
| 167 | 1.2.2 Fixed login problems. |
| 168 | 1.2.1 Added polish translation. |
| 169 | 1.2.0 Added spanish translation. |
| 170 | 1.1.2 Bugfix: Missing include at login check. |
| 171 | 1.1.1 Bugfix: Now works with SM 1.1.1 and 1.1.2. To do this check during |
| 172 | login is disabled with these versions. |
| 173 | 1.1 Bugfix: Now messages deletes correctly from pop servers. |
| 174 | 1.0 Added check during folder refresh and check during login code. |
| 175 | 0.9 Added an alias for each server. Changed default encryption key, please |
| 176 | reenter passwords if you're not using environment system. |
| 177 | 0.8 Better encryption security through env variables. |
| 178 | 0.7 Added password encryption and strings internationalization. |
| 179 | ---------------------------------------------------------------------------- |
| 180 | 0.6 Bugfix for folder list and typo |
| 181 | set_time_limit of 20 seconds per message (to avoid timeout errors) |
| 182 | 0.5 Works properly for servers that have 0 messages to fetch |
| 183 | ---------------------------------------------------------------------------- |
| 184 | Tomaso Minelli <minni@minnata.net> |
| 185 | ---------------------------------------------------------------------------- |
| 186 | 0.4 Allow an infinite amount of remote servers |
| 187 | If password is empty, prompt on check |
| 188 | Save messages into a local IMAP folder instead of INBOX |
| 189 | (Tyler) Uses new 1.1.1 validate.php format |
| 190 | ---------------------------------------------------------------------------- |
| 191 | Joshua Pollak <pardsbane@offthehill.org> |
| 192 | ---------------------------------------------------------------------------- |
| 193 | 0.3 Converted fetch routine to use the POP3 object from thewebmasters.net |
| 194 | Added Leave Mail on Server option |
| 195 | Now only downloads new messages if the pop server supports UIDL. |
| 196 | ---------------------------------------------------------------------------- |
| 197 | 0.2 Now saves account information |
| 198 | 0.1 Initial release by Tyler Akins |
| 199 | ---------------------------------------------------------------------------- |