[squirrelmail.git] / plugins / mail_fetch / README

Mail Fetch

Downloads mail from a pop3 server to your SquirrelMail account.

Features
========

* Copies messages from remote server
* Saves server, alias, username, and password in prefs file...
* 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 folder refreshes.
* Allows gettext translations.


Description
===========

Feel like grabbing your messages from a different mail server into
SquirrelMail?  This might be able to help.


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_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
dispayed.

If you want to check mail periodicaly choose "Check mail during login"
or "Check mail during folder refresh". Of course passwords have to be
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
included configuration file:

<Directory "/usr/local/squirrelmail">
    SetEnv MF_TIT "MailFetch Secure for SquirrelMail 1.x"
</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
where you decided to place this must be root only readable.

The second way is to edit functions.php and look for:

    if( !isset( $MF_TIT ) ) {
        $MF_TIT = "MailFetch 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.

To maintain compatibilty with older systems, mail_fetch can work with old
pref files, with no encrypted passwords. If this occurs, you'll see that
the "Encrypt Password" checkbox in the option page is not checked. If you
reenter account's passwords the system will switch to encrypted mode.


Future Work
===========

* Add IMAP server stealing

* Limit number of pop accounts


Installation
============

Go back to the main directory, run configure and add the plugin.

Some plugin settings can be adjusted in config/mail_fetch_config.php or
plugins/mail_fetch/config.php files. 

See plugins/mail_fetch/config_sample.php


Note for mod_gzip users
=======================

As fetching module shows information while fetching is taking place, it
is a good idea to disable compression for that operation. The way to do
this with mod_gzip is:

mod_gzip_item_exclude       file fetch.php


Note for Newmail Plugin users
=============================

In order to Newmail plugin detect new mails during folder refreshes
make sure that Mail_Fetch is listed first that Newmail in the
SM configuration. To do so you only have to remove Newmail plugin
and then add it again.


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.
Commit	Line	Data
	1	Mail Fetch
	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 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	Go back to the main directory, run configure and add the plugin.
	90
	91	Some plugin settings can be adjusted in config/mail_fetch_config.php or
	92	plugins/mail_fetch/config.php files.
	93
	94	See plugins/mail_fetch/config_sample.php
	95
	96
	97	Note for mod_gzip users
	98	=======================
	99
	100	As fetching module shows information while fetching is taking place, it
	101	is a good idea to disable compression for that operation. The way to do
	102	this with mod_gzip is:
	103
	104	mod_gzip_item_exclude file fetch.php
	105
	106
	107	Note for Newmail Plugin users
	108	=============================
	109
	110	In order to Newmail plugin detect new mails during folder refreshes
	111	make sure that Mail_Fetch is listed first that Newmail in the
	112	SM configuration. To do so you only have to remove Newmail plugin
	113	and then add it again.
	114
	115
	116	Credits
	117	=======
	118
	119	This plugin has been originally created by Tyler Akins, with contributions
	120	from Philippe Mingo, Tomaso Minelli and Joshua Pollak. It's now maintained
	121	by the SquirrelMail Project Team.
	122