'\" t
.\"     Title: dbmail-users
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 12/09/2023
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "DBMAIL\-USERS" "8" "12/09/2023" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dbmail-users \- manages the DBMail user database\&.
.SH "SYNOPSIS"
.sp
dbmail\-users { \-a username | \-c username } [ \-g clientid ] [ \-m maxmail] [ \-p passwordtype ] [ \-P shadowfile ] [ \-w password ] [ \-W passwordfile] [ \-u username ] [ \-s aliases ] [ \-S aliases ]
.sp
dbmail\-users { \-d username | \-e username }
.sp
dbmail\-users \-l userspec
.sp
dbmail\-users \-x alias [ \-t forwards ] [ \-T forwards ]
.SH "DESCRIPTION"
.sp
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"
.PP
\-a user
.RS 4
Add a user
.RE
.PP
\-d user
.RS 4
Delete a user
.RE
.PP
\-c user
.RS 4
Change details for a user
.RE
.PP
\-e user
.RS 4
Empty all mailboxes for a user
.RE
.PP
\-l uspec
.RS 4
List information for matching users
.RE
.PP
\-x alias
.RS 4
Create an external forwarding address
.RE
.SH "MINOR OPTIONS"
.PP
\-w passwd
.RS 4
Specify user\(cqs password on the command line
.RE
.PP
\-W [file]
.RS 4
Read from a file or prompt for a user\(cqs password
.RE
.PP
\-p pwtype
.RS 4
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, whirlpool, sha512, sha256, sha1, tiger\&.
.RE
.PP
\-P [file]
.RS 4
Pull encrypted password from the shadow file
.RE
.PP
\-u user
.RS 4
New username (only useful for \-c, change)
.RE
.PP
\-g cid
.RS 4
Assign the user to a client group\&.
.RE
.PP
\-m max
.RS 4
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\&.
.RE
.PP
\-s alias[,alias\&...]
.RS 4
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\&.
.RE
.PP
\-S alias[,alias\&...]
.RS 4
Removes a list of recipient aliases\&. Use wildcards ? and * to match any single character and any number of characters, respectively\&.
.RE
.PP
\-t forward[,forward\&...]
.RS 4
Adds a list of deliver\-to forwards\&.
.RE
.PP
\-T forward[,forward\&...]
.RS 4
Removes a list of deliver\-to forwards\&. Use wildcards ? and * to match any single character and any number of characters, respectively\&.
.RE
.SH "COMMON OPTIONS"
.PP
\-f configfile
.RS 4
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\(cqs preferred config file location\&. Debian is patched to have /etc/dbmail/dbmail\&.conf as the default\&.
.RE
.PP
\-q
.RS 4
Quietly skip interactive prompts and helpful status messages which would otherwise be printed to stdout\&. Use two \-q\(cqs to silence errors which would otherwise be printed to stderr\&.
.RE
.PP
\-v
.RS 4
Operate verbosely\&. Some of the utilities in the DBMail suite can take two \-v\(cqs for extra verbosity\&. Those which don\(cqt understand this convention won\(cqt complain about having the extra \-v and will simply operate at their normal verbosity\&.
.RE
.PP
\-V
.RS 4
Show the version and copyright, then exit\&.
.RE
.PP
\-h
.RS 4
Show a brief summary of options, then exit\&.
.RE
.SH "ALIASES VS\&. FORWARDS"
.sp
One question we often see on the \m[blue]\fBdbmail@dbmail\&.org\fR\m[]\&\s-2\u[1]\d\s+2 mailing list is what the difference is between aliases and forwards\&. When using dbmail\-users, the different command line options are there because an alias attaches some arbitrary address to a particular user\(cqs account, while a forward attaches some arbitrary address another arbitrary address or pipe out\&.
.sp
When using dbmail\-users with major option \-c, you must use minor option \-s/\-S for modifying aliases\&. When using dbmail\-users with major option \-x, you must use \-t/\-T for modifying forwards\&.
.SH "ALIASES"
.sp
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:
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-a baz \-p crypt \-w psword
.fi
.if n \{\
.RE
.\}
.sp
will \fBnot\fR actually receive any mail yet! You must be sure to add an alias:
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-c baz \-s baz@foodomain
.fi
.if n \{\
.RE
.\}
.sp
You may add multiple aliases by repeatedly calling the dbmail\-users(8) utility, or by calling it with a comma\-separated list of aliases:
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-c baz \-s baz@foodomain,baz@bardomain
.fi
.if n \{\
.RE
.\}
.sp
Three catch\-all modes are also supported, for domains, sub\-domains, and local parts:
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-a baz \-s @bazdomain
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-a baz \-s @\&.allsubs\&.bazdomain
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-a baz \-s baz@
.fi
.if n \{\
.RE
.\}
.sp
The first example catches email addressed to any user @bazdomain and delivers it to Baz\(cqs INBOX\&. The second example catch email address to any user at any subdomain below \&.allsubs\&.bazdomain (\fBnot\fR including allsubs\&.bazdomain itself!) The third example catches email addressed to baz@ at any domain\&.
.sp
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"
.sp
Incoming messages addressed to particular email addresses can be forwarded out to outside email addresses, piped out to a command (when prepended with | \fIpipe\fR) or piped out with an mbox\-style From line to a command (when prepended with ! \fIbang\fR)\&. For example:
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-x bar@domain \-t bar@another\&.domain
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-x bar@domain \-t "|/usr/sbin/superspamtrapper"
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-x bar@domain \-t "!cat > /var/spool/mail/bar/whatever\&.mbox"
.fi
.if n \{\
.RE
.\}
.sp
Forwards can be listed using the same \-l command as for users\&. For example, to see where the local address \m[blue]\fBbar@domain\fR\m[]\&\s-2\u[2]\d\s+2 might be forwarded to, use this:
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-l bar@domain
  forward [bar@domain] to [bar@another\&.domain]
  forward [bar@domain] to [|/usr/sbin/superspamtrapper]
  forward [bar@domain] to [!cat > /var/spool/mail/bar/whatever\&.mbox]
.fi
.if n \{\
.RE
.\}
.sp
Forwards can be removed using basic glob style pattern matching\&. A ? \fIquestion\fR means "match zero or one of any character" and * \fIasterisk\fR means "match zero or more of any character\&." For example:
.sp
.if n \{\
.RS 4
.\}
.nf
dbmail\-users \-x bar@domain \-T "*"
.fi
.if n \{\
.RE
.\}
.sp
will complete and totally remove the \fIbar@domain\fR external alias and all of its forwarding addresses and commands\&.
.SH "BUGS"
.sp
If you experience inexplicable problems with DBMail, please report the issue to the \m[blue]\fBDBMail Bug Tracker\fR\m[]\&\s-2\u[3]\d\s+2\&.
.SH "LICENSE"
.sp
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)"
.sp
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\&.
.sp
.if n \{\
.RS 4
.\}
.nf
Alan Hicks          Persistent Objects Ltd https://p\-o\&.co\&.uk
Eelco van Beek      Aaron Stone            Paul J Stevens
Roel Rozendaal      Open Source Engineer   NFG Net Facilities Group BV
Ilja Booij          Palo Alto, CA USA      http://www\&.nfg\&.nl
IC&S                http://hydricacid\&.com
http://www\&.ic\-s\&.nl
.fi
.if n \{\
.RE
.\}
.SH "NOTES"
.IP " 1." 4
dbmail@dbmail.org
.RS 4
\%mailto:dbmail@dbmail.org
.RE
.IP " 2." 4
bar@domain
.RS 4
\%mailto:bar@domain
.RE
.IP " 3." 4
DBMail Bug Tracker
.RS 4
\%https://github.com/dbmail/dbmail/issues
.RE