.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "DBMAIL-USERS" 8 "" "" ""
.SH NAME
dbmail-users \- manages the DBMail user database.
.SH "SYNOPSIS"


dbmail\-users { \-a username | \-c username } [ \-g clientid ] [ \-m maxmail] [ \-p passwordtype ] [ \-P shadowfile ] [ \-w password ] [ \-W passwordfile] [ \-u username ] [ \-s aliases ] [ \-S aliases ]


dbmail\-users { \-d username | \-e username }


dbmail\-users \-l userspec


dbmail\-users \-x alias [ \-t forwards ] [ \-T forwards ]

.SH "DESCRIPTION"


The dbmail\-users program enables you to manage the DBMail users\&. It lets you add, delete and change users as well as show information about a specific user or display a list of existing users\&. It also has the capability of adding/removing separate aliases\&.

.SH "MODE OPTIONS"

.TP
\-a user
Add a user

.TP
\-d user
Delete a user

.TP
\-c user
Change details for a user

.TP
\-e user
Empty all mailboxes for a user

.TP
\-l uspec
List information for matching users

.TP
\-x alias
Create an external forwarding address

.SH "MINOR OPTIONS"

.TP
\-w passwd
Specify user's password on the command line

.TP
\-W [file]
Read from a file or prompt for a user's password

.TP
\-p pwtype
Password type may be one of the following: plaintext, crypt, md5\-hash, md5\-digest, crypt\-raw, md5\-hash\-raw, md5\-digest\-raw, md5\-base64, md5\-base64\-raw\&.

.TP
\-P [file]
Pull encrypted password from the shadow file

.TP
\-u user
New username (only useful for \-c, change)

.TP
\-g cid
Assign the user to a client group\&.

.TP
\-m max
Set the maximum mail quota in <bytes>B, <kbytes>K, or <mbytes>M, default in bytes If set to 0, there will be no limit\&.

.TP
\-s alias[,alias...]
Adds a list of recipient aliases\&. An alias is an e\-mail address that is being delivered to the DBMail mailsystem and should be delivered to this user\&.

.TP
\-S alias[,alias...]
Removes a list of recipient aliases\&. Use wildcards ? and * to match any single character and any number of characters, respectively\&.

.TP
\-t forward[,forward...]
Adds a list of deliver\-to forwards\&.

.TP
\-T forward[,forward...]
Removes a list of deliver\-to forwards\&. Use wildcards ? and * to match any single character and any number of characters, respectively\&.

.SH "COMMON OPTIONS"

.TP
\-f configfile
Specify an alternate config file\&. The utilities are currently hardcoded to use /etc/dbmail\&.conf for their configs, and will halt if the config file cannot be found\&. Use the \-f configfile option to specify your system's preferred config file location\&.

.TP
\-q
Quietly skip interactive prompts and helpful status messages which would otherwise be printed to stdout\&. Use two \-q's to silence errors which would otherwise be printed to stderr\&.

.TP
\-v
Operate verbosely\&. Some of the utilities in the DBMail suite can take two \-v's for extra verbosity\&. Those which don't understand this convention won't complain about having the extra \-v and will simply operate at their normal verbosity\&.

.TP
\-V
Show the version and copyright, then exit\&.

.TP
\-h
Show a brief summary of options, then exit\&.

.SH "ALIASES"


When creating a new user account, you must either add an initial alias that delivers to the account name, or make the account in the form of a fully qualified email address\&. For example, the user named \fIBaz\fR created like this:


dbmail\-users \-a baz \-p crypt \-w psword


will \fInot\fR actually receive any mail yet! You must be sure to add an alias:


dbmail\-users \-c baz \-s baz@foodomain


You may add multiple aliases by repeatedly calling the dbmail\-users(8) utility, or by calling it with a comma\-separated list of aliases:


dbmail\-users \-c baz \-s baz@foodomain,baz@bardomain


Two catch\-all modes are also supported, for domains and for local parts:


dbmail\-users \-a baz \-s @bazdomain


dbmail\-users \-a baz \-s baz@


The first example catches email addressed to any user @bazdomain and delivers it to Baz's INBOX\&. The second example catches email addressed to baz@ any domain and also delivers it to Baz's INBOX\&.


There is no support for delivering to a particular mailbox other than INBOX via the aliases system\&. Please use a Sieve script to sort mail like this\&.

.SH "FORWARDS"


Incoming messages addressed to particular email addresses can be forwarded out to outside email addresses, piped out to a command or piped out with an mbox\-style From line to a command\&. For example:


dbmail\-users \-x bar@domain \-t bar@another\&.domain


dbmail\-users \-x bar@domain \-t "|/usr/sbin/superspamtrapper"


dbmail\-users \-x bar@domain \-t "!cat > /var/spool/mail/bar/whatever\&.mbox"


Forwards can be removed using basic glob style pattern matching\&. A ? means "match zero or one of any character" and * means "match zero or more of any character\&." For example:


dbmail\-users \-x bar@domain \-t "*"


will complete and totally remove the \fIbar@domain\fR external alias and all of its forwarding addresses and commands\&.

.SH "BUGS"


If you experience inexplicable problems with DBMAil, please report the issue to the DBMail Bug Tracker: \fIhttp://dbmail.org/index.php?page=bugs\fR\&.

.SH "LICENSE"


DBMail and its components are distributed under the terms of the GNU General Public License\&. Copyrights are held variously by the authors listed below\&.

.SH "AUTHOR(S)"


DBMail is a collaborative effort among the core developers listed below and the tremendous help of the testers, patchers and bug hunters listed in the AUTHORS and THANKS files found in the DBMail source distribution\&.

.nf
Eelco van Beek      Aaron Stone            Paul J Stevens
Roel Rozendaal      Programmer             NFG Net Facilities Group BV
Ilja Booij          Palo Alto, CA USA      http://www\&.nfg\&.nl
IC&S                http://hydricacid\&.com
Koningsweg 4
3582 GE Utrecht
http://www\&.ic\-s\&.nl
.fi