modules/couriermta/README.txt

$Id: README.txt,v 1.1.2.4 2007/10/31 19:27:53 oadaeh Exp $

WARNING
-------
This module is still very new and will most likely chew up all your data.
Make sure you test it on a test system and make sure you have valid & tested
backups before putting it onto a production server.


ABOUT
-----
The Courier MTA module gives administrators and/or users the ability of
managing e-mail accounts on a Courier mail server through a Druapl website.

There is the possibility that this module will do more in the future, like
providing a webmail interface, or linking with one of the existing webmail
modules [1] [2] and/or providing a place to administer the mail server
configuration, but for now it is simply a user account management module.

[1] http://drupal.org/project/pontomail
[2] http://drupal.org/project/webmail


AUTHOR
------
Jason Flatt
drupal@oadaeh.net
http://drupal.org/user/4649


INSTALLATION AND CONFIGURATION
------------------------------
In order to use this module effectively, you will need to do a few things.
 * Install the module in the usual way.
 * Configure the settings on the admin/settings/couriermta page. There are
   reasonable defaults in place, in case you've setup your server in a
   conventional manor, but you should certainly change them to match your
   existing settings.
 * Change your authmysqlrc file in your Courier installation to point to the
   couriermta table in your Drupal database. A sample configuration is
   included below for your comparison.
 * Configure the included couriermta.sh shell script to fit your system.
 * Setup a cron job to run the couriermta.sh script at a regular interval. A
   15 to 30 minute interval should be fine, unless you have a busy site with
   lots of user changes, then you might want a shorter interval.


Some sample settings for a /etc/courier/authmysqlrc file:
---------------------------------------------------------
I've configured the database so that it closely matches the default file
configuration. If you leave everything as is, you should only need to specify
the MYSQL_USERNAME, MYSQL_PASSWORD, MYSQL_DATABASE, MYSQL_USER_TABLE
MYSQL_LOGIN_FIELD (to email) and MYSQL_WHERE_CLAUSE fields in your
authmysqlrc file.

Note: the spaces between the variable and the value are supposed to be tabs
and not spaces. Also, there should be no trailing spaces or tabs on any of
the lines Courier reads. Courier won't work correctly if you don't make sure
those conditions are met.

##NAME: LOCATION:0
MYSQL_SERVER	localhost
MYSQL_USERNAME	<your-drupal-database-user-name-as-defined-in-your-settings.php-file>
MYSQL_PASSWORD	<your-drupal-database-password-name-as-defined-in-your-settings.php-file>

##NAME: MYSQL_DATABASE:0
MYSQL_DATABASE	<your-drupal-database-name-as-defined-in-your-settings.php-file>

##NAME: MYSQL_USER_TABLE:0
MYSQL_USER_TABLE	couriermta_users

##NAME: MYSQL_CRYPT_PWFIELD:0
MYSQL_CRYPT_PWFIELD	crypt

##NAME: MYSQL_CLEAR_PWFIELD:0
MYSQL_CLEAR_PWFIELD	clear

##NAME: MYSQL_UID_FIELD:0
MYSQL_UID_FIELD	uid

##NAME: MYSQL_GID_FIELD:0
MYSQL_GID_FIELD	gid

##NAME: MYSQL_LOGIN_FIELD:0
MYSQL_LOGIN_FIELD	email

##NAME: MYSQL_HOME_FIELD:0
MYSQL_HOME_FIELD	home

##NAME: MYSQL_NAME_FIELD:0
MYSQL_NAME_FIELD	name

##NAME: MYSQL_MAILDIR_FIELD:0
MYSQL_MAILDIR_FIELD	maildir

##NAME: MYSQL_DEFAULTDELIVERY:0
MYSQL_DEFAULTDELIVERY	defaultdelivery

##NAME: MYSQL_QUOTA_FIELD:0
MYSQL_QUOTA_FIELD	quota

##NAME: MYSQL_AUXOPTIONS:0
MYSQL_AUXOPTIONS_FIELD	auxoptions

##NAME: MYSQL_WHERE_CLAUSE:0
MYSQL_WHERE_CLAUSE	status=1
1	$Id: README.txt,v 1.1.2.4 2007/10/31 19:27:53 oadaeh Exp $
2
3	WARNING
4	-------
5	This module is still very new and will most likely chew up all your data.
6	Make sure you test it on a test system and make sure you have valid & tested
7	backups before putting it onto a production server.
8
9
10	ABOUT
11	-----
12	The Courier MTA module gives administrators and/or users the ability of
13	managing e-mail accounts on a Courier mail server through a Druapl website.
14
15	There is the possibility that this module will do more in the future, like
16	providing a webmail interface, or linking with one of the existing webmail
17	modules [1] [2] and/or providing a place to administer the mail server
18	configuration, but for now it is simply a user account management module.
19
20	[1] http://drupal.org/project/pontomail
21	[2] http://drupal.org/project/webmail
22
23
24	AUTHOR
25	------
26	Jason Flatt
27	drupal@oadaeh.net
28	http://drupal.org/user/4649
29
30
31	INSTALLATION AND CONFIGURATION
32	------------------------------
33	In order to use this module effectively, you will need to do a few things.
34	* Install the module in the usual way.
35	* Configure the settings on the admin/settings/couriermta page. There are
36	reasonable defaults in place, in case you've setup your server in a
37	conventional manor, but you should certainly change them to match your
38	existing settings.
39	* Change your authmysqlrc file in your Courier installation to point to the
40	couriermta table in your Drupal database. A sample configuration is
41	included below for your comparison.
42	* Configure the included couriermta.sh shell script to fit your system.
43	* Setup a cron job to run the couriermta.sh script at a regular interval. A
44	15 to 30 minute interval should be fine, unless you have a busy site with
45	lots of user changes, then you might want a shorter interval.
46
47
48	Some sample settings for a /etc/courier/authmysqlrc file:
49	---------------------------------------------------------
50	I've configured the database so that it closely matches the default file
51	configuration. If you leave everything as is, you should only need to specify
52	the MYSQL_USERNAME, MYSQL_PASSWORD, MYSQL_DATABASE, MYSQL_USER_TABLE
53	MYSQL_LOGIN_FIELD (to email) and MYSQL_WHERE_CLAUSE fields in your
54	authmysqlrc file.
55
56	Note: the spaces between the variable and the value are supposed to be tabs
57	and not spaces. Also, there should be no trailing spaces or tabs on any of
58	the lines Courier reads. Courier won't work correctly if you don't make sure
59	those conditions are met.
60
61	##NAME: LOCATION:0
62	MYSQL_SERVER localhost
63	MYSQL_USERNAME <your-drupal-database-user-name-as-defined-in-your-settings.php-file>
64	MYSQL_PASSWORD <your-drupal-database-password-name-as-defined-in-your-settings.php-file>
65
66	##NAME: MYSQL_DATABASE:0
67	MYSQL_DATABASE <your-drupal-database-name-as-defined-in-your-settings.php-file>
68
69	##NAME: MYSQL_USER_TABLE:0
70	MYSQL_USER_TABLE couriermta_users
71
72	##NAME: MYSQL_CRYPT_PWFIELD:0
73	MYSQL_CRYPT_PWFIELD crypt
74
75	##NAME: MYSQL_CLEAR_PWFIELD:0
76	MYSQL_CLEAR_PWFIELD clear
77
78	##NAME: MYSQL_UID_FIELD:0
79	MYSQL_UID_FIELD uid
80
81	##NAME: MYSQL_GID_FIELD:0
82	MYSQL_GID_FIELD gid
83
84	##NAME: MYSQL_LOGIN_FIELD:0
85	MYSQL_LOGIN_FIELD email
86
87	##NAME: MYSQL_HOME_FIELD:0
88	MYSQL_HOME_FIELD home
89
90	##NAME: MYSQL_NAME_FIELD:0
91	MYSQL_NAME_FIELD name
92
93	##NAME: MYSQL_MAILDIR_FIELD:0
94	MYSQL_MAILDIR_FIELD maildir
95
96	##NAME: MYSQL_DEFAULTDELIVERY:0
97	MYSQL_DEFAULTDELIVERY defaultdelivery
98
99	##NAME: MYSQL_QUOTA_FIELD:0
100	MYSQL_QUOTA_FIELD quota
101
102	##NAME: MYSQL_AUXOPTIONS:0
103	MYSQL_AUXOPTIONS_FIELD auxoptions
104
105	##NAME: MYSQL_WHERE_CLAUSE:0
106	MYSQL_WHERE_CLAUSE status=1