phpDoc fixes
[squirrelmail.git] / plugins / mail_fetch / README
index b49219f..9b34595 100644 (file)
@@ -1,4 +1,4 @@
-Mail Fetch -- Version 1.3.0
+Mail Fetch
 
 Downloads mail from a pop3 server to your SquirrelMail account.
 
@@ -7,13 +7,13 @@ Features
 
 * Copies messages from remote server
 * Saves server, alias, username, and password in prefs file...
-* Remembers where to resume downloading messages if 
+* Remembers where to resume downloading messages if
   your pop server supports UIDL.
 * Optionally deletes mail from the remote server.
 * Allow an infinite amount of remote servers
 * Optional to not save password - prompt on check
 * Save messages into a local IMAP folder instead of INBOX
-* Check mail during login (Needs SM 1.1.3 or older). 
+* Check mail during login (Needs SM 1.1.3 or older).
 * Check mail during folder refreshes.
 * Allows gettext translations.
 
@@ -31,7 +31,7 @@ Configuration
 Under the options you can add, delete or modify server list where
 fetching mail.  For each server you can set also username and password;
 if you leave password blank, the password whore required when you fetch
-mail.  Make sure "Leave Mail On Server" is checked if you do not want 
+mail.  Make sure "Leave Mail On Server" is checked if you do not want
 Mail_Fetch to delete it from the remote server.  Once configured,
 click 'Fetch' in the SquirrelMail menu to get your mail; you can fetch
 mail from all server instead or from only one by selecting the options
@@ -43,11 +43,11 @@ entered in order for this to work.
 
 In order to secure a little bit the system, pop3 passwords can be encrypted.
 The encryption key may be defined in to places. The first, and more secure,
-is in the httpd configuration as an enviromental variable called MF_TIT 
-only accesible from the squirrelmail directory.
-the way you can do this from apache is adding the following directives to 
-httpd.conf (supposing that squirrelmail is located at /usr/local) or an
+is in the httpd configuration as an enviromental variable called MF_TIT
+only accesible from the SquirrelMail directory.
+
+the way you can do this from apache is adding the following directives to
+httpd.conf (supposing that SquirrelMail is located at /usr/local) or an
 included configuration file:
 
 <Directory "/usr/local/squirrelmail">
@@ -55,7 +55,7 @@ included configuration file:
 </Directory>
 
 Of course, you should replace the text inside double quotes with the key
-you want to (some kind of secret text). A please remember that the file 
+you want to (some kind of secret text). A please remember that the file
 where you decided to place this must be root only readable.
 
 The second way is to edit functions.php and look for:
@@ -64,7 +64,7 @@ The second way is to edit functions.php and look for:
         $MF_TIT = "MailFetch Secure for SquirrelMail 1.x";
     }
 
-Once again change the text "MailFetch 0.8 Secure for SquirrelMail 1.x"
+Once again change the text "MailFetch Secure for SquirrelMail 1.x"
 with a secret text.
 
 Please note that you must redefine passwords each time you change the key.
@@ -79,37 +79,19 @@ Future Work
 ===========
 
 * Add IMAP server stealing
+
 * Limit number of pop accounts
 
 
 Installation
 ============
 
-As with other plugins, just uncompress the archive in the plugins
-directory, go back to the main directory, run configure and add the plugin.
-
-Questions/comments/flames/etc can be sent to the SquirrelMail plugins list.
-
-Old versionn (0.7) has been updated from 0.6 by Philippe Mingo <mingo@rotedic.com>
-    IMPORTANT!!! This is a "secured" version, it makes a little encryption
-    of the pop3 passwords. In order to use this facility, systems that
-    have been using older versions (0.6 and lessers) should reenter
-    passwords using the modify button at the options page in order to
-    encrypt the password. The Encrypt passwords checkbox is only informative,
-    and it lets you know if passwords are secure or not.
-
-Old version (0.4) has been updated from Joshua's version 0.3 by
-    Tomaso Minelli <minni@minnata.net>
-    and Tyler (but only VERY minor stuff -- not worth really mentioning)
-
-Old version (0.3) has been updated from Tyler's original version 0.1 by
-    Joshua Pollak <pardsbane@offthehill.org>
+Go back to the main directory, run configure and add the plugin.
 
 
 Translations
 ============
-Translation is made in the same manner than Squirrelmail's core does.
+Translation is made in the same manner as SquirrelMail's core.
 You need to take <plugin_name>.po file, fill the template, store it
 in the appropriate locale folder under the plugin and compile the po
 file. Better than this fill the po file and send it back to the author.
@@ -135,49 +117,10 @@ SM configuration. To do so you only have to remove Newmail plugin
 and then add it again.
 
 
-ChangeLog
-=========
-
-1.3.1 Bugfix "Chiu Wai Pun" <pun@alumni.ust.hk> 
-
----------------------------------------------------------------------------
-                   Philippe Mingo <mingo@rotedic.com>
----------------------------------------------------------------------------
-1.3.0 Official SM Version - Moved into the SM package.
-1.2.6 BugFix
-1.2.5 Bugfix
-1.2.4 Optimized class.POP3. Fixed problem with spaces in folders name.
-1.2.3 non-gettext systems now works
-1.2.2 Fixed login problems.
-1.2.1 Added polish translation.
-1.2.0 Added spanish translation.
-1.1.2 Bugfix: Missing include at login check.
-1.1.1 Bugfix: Now works with SM 1.1.1 and 1.1.2. To do this check during
-      login is disabled with these versions.
-1.1   Bugfix: Now messages deletes correctly from pop servers.
-1.0   Added check during folder refresh and check during login code.
-0.9   Added an alias for each server. Changed default encryption key, please
-      reenter passwords if you're not using environment system.
-0.8   Better encryption security through env variables.
-0.7   Added password encryption and strings internationalization. 
-----------------------------------------------------------------------------
-0.6   Bugfix for folder list and typo
-      set_time_limit of 20 seconds per message (to avoid timeout errors)
-0.5   Works properly for servers that have 0 messages to fetch
-----------------------------------------------------------------------------
-                    Tomaso Minelli <minni@minnata.net>
-----------------------------------------------------------------------------
-0.4   Allow an infinite amount of remote servers
-      If password is empty, prompt on check
-      Save messages into a local IMAP folder instead of INBOX
-      (Tyler) Uses new 1.1.1 validate.php format
-----------------------------------------------------------------------------
-                 Joshua Pollak <pardsbane@offthehill.org>
-----------------------------------------------------------------------------
-0.3   Converted fetch routine to use the POP3 object from thewebmasters.net
-      Added Leave Mail on Server option
-      Now only downloads new messages if the pop server supports UIDL.
-----------------------------------------------------------------------------      
-0.2   Now saves account information
-0.1   Initial release by Tyler Akins
-----------------------------------------------------------------------------
+Credits
+=======
+
+This plugin has been originally created by Tyler Akins, with contributions
+from Philippe Mingo, Tomaso Minelli and Joshua Pollak. It's now maintained
+by the SquirrelMail Project Team.
+