[hcoop/zz_old/domtool.git] / src / vmail / README

VIRTUAL MAILBOXES FOR COURIER IMAP


Here are some simple tools for managing virtual e-mailboxes for
Courier IMAP (http://www.inter7.com/courierimap/courierimap.html).

A short sample session should demonstrate how to use the vmail and
reloadusers command line tools:

% vmail your.domain add new.user 
Password: password 
Reenter password: password 
Mailbox created. 
 
% vmail your.domain list 
new.user 
 
% vmail your.domain passwd new.user 
Password: password' 
Reenter password: password' 
Password set. 
 
% reloadusers 

After this, where mailboxDir is the directory set in config.sml, a
Maildir mailbox exists in mailboxDir/your.domain/new.user, and
login/password data for Courier is in the directories/files given in
config.sml. You must set up an MTA to properly deliver mail to these
mailboxes for this to be useful.

vmail only allows a user to administer virtual mailboxes for a domain
whose directory in the domtool tree the user's current group has write
access to. Thus, it is important to maintain g+w in these directories
for this to work.

Actually, this only matters when you use a
sudo-based solution like mentioned in the main README file. You might
be able to find a better way of doing things. At hcoop, we have a
'vmail' user that owns the mailbox directory. Users are allowed via
sudo to run vmail as user vmail, and user vmail is allowed to run the
Courier userdb and userdbpw programs as root. All domtool users are
allowed to run reloadusers as root.
Commit	Line	Data
182a2654 AC	1	VIRTUAL MAILBOXES FOR COURIER IMAP
	2
	3
	4	Here are some simple tools for managing virtual e-mailboxes for
	5	Courier IMAP (http://www.inter7.com/courierimap/courierimap.html).
	6
	7	A short sample session should demonstrate how to use the vmail and
	8	reloadusers command line tools:
	9
	10	% vmail your.domain add new.user
	11	Password: password
	12	Reenter password: password
	13	Mailbox created.
	14
	15	% vmail your.domain list
	16	new.user
	17
	18	% vmail your.domain passwd new.user
	19	Password: password'
	20	Reenter password: password'
	21	Password set.
	22
	23	% reloadusers
	24
	25	After this, where mailboxDir is the directory set in config.sml, a
	26	Maildir mailbox exists in mailboxDir/your.domain/new.user, and
	27	login/password data for Courier is in the directories/files given in
	28	config.sml. You must set up an MTA to properly deliver mail to these
	29	mailboxes for this to be useful.
	30
	31	vmail only allows a user to administer virtual mailboxes for a domain
	32	whose directory in the domtool tree the user's current group has write
	33	access to. Thus, it is important to maintain g+w in these directories
	34	for this to work.
	35
	36	Actually, this only matters when you use a
	37	sudo-based solution like mentioned in the main README file. You might
	38	be able to find a better way of doing things. At hcoop, we have a
	39	'vmail' user that owns the mailbox directory. Users are allowed via
	40	sudo to run vmail as user vmail, and user vmail is allowed to run the
	41	Courier userdb and userdbpw programs as root. All domtool users are
	42	allowed to run reloadusers as root.
	43