| 1 |
$Id: README.txt,v 1.2 2007/01/18 05:45:20 yecarrillo Exp $
|
| 2 |
|
| 3 |
Overview
|
| 4 |
---------
|
| 5 |
|
| 6 |
IMAP stands for Internet Message Access Protocol. It is a method of accessing
|
| 7 |
electronic mail or bulletin board messages that are kept on a (possibly shared)
|
| 8 |
mail server. In other words, it permits a "client" email program to access
|
| 9 |
remote message stores as if they were local. For example, email stored on an
|
| 10 |
IMAP server can be manipulated from a desktop computer at home, a workstation at
|
| 11 |
the office, and a notebook computer while traveling, without the need to
|
| 12 |
transfer messages or files back and forth between these computers.
|
| 13 |
|
| 14 |
POP3 stands for Post Office Protocol version 3 (POP3), an application-layer
|
| 15 |
Internet standard protocol, to retrieve e-mail from a remote server over a
|
| 16 |
TCP/IP connection.
|
| 17 |
|
| 18 |
The Network News Transfer Protocol or NNTP is an Internet application protocol
|
| 19 |
used primarily for reading and posting Usenet articles, as well as transferring
|
| 20 |
news among news servers.
|
| 21 |
|
| 22 |
This module allows to your Drupal users to authenticate against one or various
|
| 23 |
IMAP/POP3/NNTP servers. They must supply a valid IMAP/POP3/NNTP email/news
|
| 24 |
account in the form "user@server" style as username to login.
|
| 25 |
|
| 26 |
Requirements
|
| 27 |
------------
|
| 28 |
* Drupal 5.x or later
|
| 29 |
* Php IMAP extension installed on server
|
| 30 |
[http://www.php.net/manual/en/ref.imap.php]
|
| 31 |
|
| 32 |
Install
|
| 33 |
-------
|
| 34 |
|
| 35 |
1. Copy the 'imap_auth' module directory in to your Drupal
|
| 36 |
modules directory as usual
|
| 37 |
|
| 38 |
2. Activate the module via the Drupal module configuration menu
|
| 39 |
(Administer >> Site building >> Modules)
|
| 40 |
|
| 41 |
3. Configuration: "Administer >> Site configuration >> IMAP auth"
|
| 42 |
|
| 43 |
IMAP authentication:
|
| 44 |
* Enabled: Users will be able to get logged in using IMAP/POP3/NNTP accounts
|
| 45 |
* Disabled : Turn off IMAP authentication.
|
| 46 |
|
| 47 |
IMAP Services:
|
| 48 |
* Use a single asterisk (*) value to allow IMAP/POP3/NNTP authentication
|
| 49 |
against any server
|
| 50 |
* Provide a list of valid IMAP/POP3/NNTP servers. Add one server per row with any of these
|
| 51 |
formats (you can mix them):
|
| 52 |
|
| 53 |
a) "server_alias"
|
| 54 |
Example: mycompany.com
|
| 55 |
server_alias is the part after "@" of valid email/news IMAP/POP3/NNTP accounts.
|
| 56 |
Module will use "{server_alias:143}INBOX" as default string_mailbox
|
| 57 |
to open IMAP connections.
|
| 58 |
b) "server_alias,string_mailbox"
|
| 59 |
Example: mycompany.com,{mail.mycompany.com:143/imap/notls}INBOX
|
| 60 |
You can set explicit string_mailbox strings plus server_alias. This is useful
|
| 61 |
when the part after "@" of valid email IMAP accounts is different
|
| 62 |
of IMAP auth server, or when you need to set secure connections or POP3
|
| 63 |
connections.
|
| 64 |
|
| 65 |
Read more about string_mailbox values:
|
| 66 |
http://www.php.net/manual/en/function.imap-open.php
|
| 67 |
|
| 68 |
Note:
|
| 69 |
To allow external user authentication with imap_auth, you need to set
|
| 70 |
in "Administer >> User management >> User settings":
|
| 71 |
|
| 72 |
"Public registrations:"
|
| 73 |
"Visitors can create accounts and no administrator approval is required."
|
| 74 |
|
| 75 |
[http://drupal.org/node/27997]
|
| 76 |
|
| 77 |
Authors
|
| 78 |
-------
|
| 79 |
Eduin Carrillo [http://drupal.org/user/16997]
|
| 80 |
Kenn Persinger [http://drupal.org/user/25977]
|
| 81 |
|
| 82 |
License
|
| 83 |
-------
|
| 84 |
GPL (see LICENSE.txt)
|
Parent Directory
| 
Revision Log
| 
Revision Graph