phpDoc fixes
[squirrelmail.git] / plugins / mail_fetch / README
CommitLineData
7aa22276 1Mail Fetch
d622d38a 2
3Downloads mail from a pop3 server to your SquirrelMail account.
4
5Features
6========
7
8* Copies messages from remote server
9* Saves server, alias, username, and password in prefs file...
598294a7 10* Remembers where to resume downloading messages if
d622d38a 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
598294a7 16* Check mail during login (Needs SM 1.1.3 or older).
d622d38a 17* Check mail during folder refreshes.
18* Allows gettext translations.
19
20
21Description
22===========
23
24Feel like grabbing your messages from a different mail server into
25SquirrelMail? This might be able to help.
26
27
28Configuration
29=============
30
31Under the options you can add, delete or modify server list where
32fetching mail. For each server you can set also username and password;
33if you leave password blank, the password whore required when you fetch
598294a7 34mail. Make sure "Leave Mail On Server" is checked if you do not want
d622d38a 35Mail_Fetch to delete it from the remote server. Once configured,
36click 'Fetch' in the SquirrelMail menu to get your mail; you can fetch
37mail from all server instead or from only one by selecting the options
38dispayed.
39
40If you want to check mail periodicaly choose "Check mail during login"
41or "Check mail during folder refresh". Of course passwords have to be
42entered in order for this to work.
43
44In order to secure a little bit the system, pop3 passwords can be encrypted.
45The encryption key may be defined in to places. The first, and more secure,
598294a7 46is in the httpd configuration as an enviromental variable called MF_TIT
47only accesible from the SquirrelMail directory.
48
49the way you can do this from apache is adding the following directives to
50httpd.conf (supposing that SquirrelMail is located at /usr/local) or an
d622d38a 51included configuration file:
52
53<Directory "/usr/local/squirrelmail">
54 SetEnv MF_TIT "MailFetch Secure for SquirrelMail 1.x"
55</Directory>
56
57Of course, you should replace the text inside double quotes with the key
598294a7 58you want to (some kind of secret text). A please remember that the file
d622d38a 59where you decided to place this must be root only readable.
60
61The 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
7aa22276 67Once again change the text "MailFetch Secure for SquirrelMail 1.x"
d622d38a 68with a secret text.
69
70Please note that you must redefine passwords each time you change the key.
71
72To maintain compatibilty with older systems, mail_fetch can work with old
73pref files, with no encrypted passwords. If this occurs, you'll see that
74the "Encrypt Password" checkbox in the option page is not checked. If you
75reenter account's passwords the system will switch to encrypted mode.
76
77
78Future Work
79===========
80
81* Add IMAP server stealing
598294a7 82
d622d38a 83* Limit number of pop accounts
84
85
86Installation
87============
88
7aa22276 89Go back to the main directory, run configure and add the plugin.
d622d38a 90
91
92Translations
93============
598294a7 94Translation is made in the same manner as SquirrelMail's core.
d622d38a 95You need to take <plugin_name>.po file, fill the template, store it
96in the appropriate locale folder under the plugin and compile the po
97file. Better than this fill the po file and send it back to the author.
98The translation will be included in the next release of the plugin.
99
100
101Note for mod_gzip users
102=======================
103
104As fetching module shows information while fetching is taking place, it
105is a good idea to disable compression for that operation. The way to do
106this with mod_gzip is:
107
108mod_gzip_item_exclude file fetch.php
109
110
111Note for Newmail Plugin users
112=============================
113
114In order to Newmail plugin detect new mails during folder refreshes
115make sure that Mail_Fetch is listed first that Newmail in the
116SM configuration. To do so you only have to remove Newmail plugin
117and then add it again.
118
119
7aa22276 120Credits
121=======
122
123This plugin has been originally created by Tyler Akins, with contributions
124from Philippe Mingo, Tomaso Minelli and Joshua Pollak. It's now maintained
125by the SquirrelMail Project Team.
126