modules/isp_login/README.txt

$Id$

Overview
--------

The ISP Login module lets users log in using any IMAP or POP3 email account. It
is mainly intended for ISPs which have lots of virtual domains per server, and
maybe different mail login methods on different servers.

The user must login using his complete e-mail address, in the form
user@mail_domain, and the corresponding password. Then the module tries to open
a POP3 or IMAP connection. If it succeeds, the user is allowed in, and a new
drupal account is created for him if necessary.

The module:
-----------

* Extracts the username and mail_domain from (Drupal) user login form.
  (the user must log in as username@mail_domain)
* Queries the DNS system to get the MX host designated for mail_domain.
  The returned value is the mail_host
* If no MX record is returned, then it assumes that mail_domain is a
  host (not a domain) and must be the mail_host itself
* If mail_host is still a DNS name, it is converted into the corresponding
  IP address using another DNS query.
* If mail_host is *not* listed on the ISP Login settings page the login is
  denied.
* If it is, the module tries to connect to mail_host using the method
  described there. The login is allowed if the connection succeeds, and
  denied otherwise.
* On the first login, a new drupal account is automatically created for
  the new user.

See the ISP Login settings page for more information about the available
mail server access methods.


Requirements
------------

* Drupal 5.x or higher
* Php IMAP extension installed
  See http://www.php.net/manual/en/ref.imap.php
* PHP 5 or higher for full functionality
  (for "did" mail server access mode only)


Install
-------

1. Copy the 'isp_login' module directory into the Drupal
   modules directory as usual

2. Activate the module via the Drupal module configuration menu:
   Administer >> Site building >> Modules

3. Configuration:
   Administer >> User management >> ISP Login


License
-------

GPL
1	$Id$
2
3	Overview
4	--------
5
6	The ISP Login module lets users log in using any IMAP or POP3 email account. It
7	is mainly intended for ISPs which have lots of virtual domains per server, and
8	maybe different mail login methods on different servers.
9
10	The user must login using his complete e-mail address, in the form
11	user@mail_domain, and the corresponding password. Then the module tries to open
12	a POP3 or IMAP connection. If it succeeds, the user is allowed in, and a new
13	drupal account is created for him if necessary.
14
15	The module:
16	-----------
17
18	* Extracts the username and mail_domain from (Drupal) user login form.
19	(the user must log in as username@mail_domain)
20	* Queries the DNS system to get the MX host designated for mail_domain.
21	The returned value is the mail_host
22	* If no MX record is returned, then it assumes that mail_domain is a
23	host (not a domain) and must be the mail_host itself
24	* If mail_host is still a DNS name, it is converted into the corresponding
25	IP address using another DNS query.
26	* If mail_host is not listed on the ISP Login settings page the login is
27	denied.
28	* If it is, the module tries to connect to mail_host using the method
29	described there. The login is allowed if the connection succeeds, and
30	denied otherwise.
31	* On the first login, a new drupal account is automatically created for
32	the new user.
33
34	See the ISP Login settings page for more information about the available
35	mail server access methods.
36
37
38	Requirements
39	------------
40
41	* Drupal 5.x or higher
42	* Php IMAP extension installed
43	See http://www.php.net/manual/en/ref.imap.php
44	* PHP 5 or higher for full functionality
45	(for "did" mail server access mode only)
46
47
48	Install
49	-------
50
51	1. Copy the 'isp_login' module directory into the Drupal
52	modules directory as usual
53
54	2. Activate the module via the Drupal module configuration menu:
55	Administer >> Site building >> Modules
56
57	3. Configuration:
58	Administer >> User management >> ISP Login
59
60
61	License
62	-------
63
64	GPL