1DBMAIL-USERS(8) DBMAIL-USERS(8)
2
6 dbmail-users - manages the DBMail user database.
7
9 dbmail-users { -a username | -c username } [ -g clientid ] [ -m
10 maxmail] [ -p passwordtype ] [ -P shadowfile ] [ -w password ] [ -W
11 passwordfile] [ -u username ] [ -s aliases ] [ -S aliases ]
12 dbmail-users { -d username | -e username }
14 dbmail-users -l [userspec]
16 dbmail-users -x alias [ -t forwards ] [ -T forwards ]
18
20 The dbmail-users program enables you to manage the DBMail users. It
21 lets you add, delete and change users as well as show information about
22 a specific user or display a list of existing users. It also has the
23 capability of adding/removing separate aliases.
24
26 -a user
27 Add a user
28 -d user
30 Delete a user
31 -c user
33 Change details for a user
34 -e user
36 Empty all mailboxes for a user
37 -l [userspec]
39 List information for matching users. If no userspec is given, lists
40 all users and forwards in this format:
41 -- users --
43 username : the letter 'x' : user id number : client id number : quota : used : comma, separated, aliases
44 -- forwards --
46 alias: comma, separated, forwards
47 -x alias
49 Create an external forwarding address
50
52 -w passwd
53 Specify user’s password on the command line
54 -W [file]
56 Read from a file or prompt for a user’s password
57 -p pwtype
59 Password type may be one of the following: plaintext, crypt,
60 md5-hash, md5-digest, crypt-raw, md5-hash-raw, md5-digest-raw,
61 md5-base64, md5-base64-raw.
62 -P [file]
64 Pull encrypted password from the shadow file
65 -u user
67 New username (only useful for -c, change)
68 -g cid
70 Assign the user to a client group.
71 -m max
73 Set the maximum mail quota in <bytes>B, <kbytes>K, or <mbytes>M,
74 default in bytes If set to 0, there will be no limit.
75 -s alias[,alias...]
77 Adds a list of recipient aliases. An alias is an e-mail address
78 that is being delivered to the DBMail mailsystem and should be
79 delivered to this user.
80 -S alias[,alias...]
82 Removes a list of recipient aliases. Use wildcards ? and * to match
83 any single character and any number of characters, respectively.
84 -t forward[,forward...]
86 Adds a list of deliver-to forwards.
87 -T forward[,forward...]
89 Removes a list of deliver-to forwards. Use wildcards ? and * to
90 match any single character and any number of characters,
91 respectively.
92
94 -f configfile
95 Specify an alternate config file. The utilities are currently
96 hardcoded to use /etc/dbmail.conf for their configs, and will halt
97 if the config file cannot be found. Use the -f configfile option to
98 specify your system’s preferred config file location.
99 -q
101 Quietly skip interactive prompts and helpful status messages which
102 would otherwise be printed to stdout. Use two -q’s to silence
103 errors which would otherwise be printed to stderr.
104 -v
106 Operate verbosely. Some of the utilities in the DBMail suite can
107 take two -v’s for extra verbosity. Those which don’t understand
108 this convention won’t complain about having the extra -v and will
109 simply operate at their normal verbosity.
110 -V
112 Show the version and copyright, then exit.
113 -h
115 Show a brief summary of options, then exit.
116
118 One question we often see on the dbmail@dbmail.org[1] mailing list is
119 what the difference is between aliases and forwards. When using
120 dbmail-users, the different command line options are there because an
121 alias attaches some arbitrary address to a particular user’s account,
122 while a forward attaches some arbitrary address another arbitrary
123 address or pipe out.
124 When using dbmail-users with major option -c, you must use minor option
126 -s/-S for modifying aliases. When using dbmail-users with major option
127 -x, you must use -t/-T for modifying forwards.
128
130 When creating a new user account, you must either add an initial alias
131 that delivers to the account name, or make the account in the form of a
132 fully qualified email address. For example, the user named Baz created
133 like this:
134 dbmail-users -a baz -p crypt -w psword
136 will not actually receive any mail yet! You must be sure to add an
138 alias:
139 dbmail-users -c baz -s baz@foodomain
141 You may add multiple aliases by repeatedly calling the dbmail-users(8)
143 utility, or by calling it with a comma-separated list of aliases:
144 dbmail-users -c baz -s baz@foodomain,baz@bardomain
146 Three catch-all modes are also supported, for domains, sub-domains, and
148 local parts:
149 dbmail-users -a baz -s @bazdomain
151 dbmail-users -a baz -s @.allsubs.bazdomain
153 dbmail-users -a baz -s baz@
155 The first example catches email addressed to any user @bazdomain and
157 delivers it to Baz’s INBOX. The second example catch email address to
158 any user at any subdomain below .allsubs.bazdomain (not including
159 allsubs.bazdomain itself!) The third example catches email addressed to
160 baz@ at any domain.
161 There is no support for delivering to a particular mailbox other than
163 INBOX via the aliases system. Please use a Sieve script to sort mail
164 like this.
165
167 Incoming messages addressed to particular email addresses can be
168 forwarded out to outside email addresses, piped out to a command (when
169 prepended with | pipe) or piped out with an mbox-style From line to a
170 command (when prepended with ! bang). For example:
171 dbmail-users -x bar@domain -t bar@another.domain
173 dbmail-users -x bar@domain -t "|/usr/sbin/superspamtrapper"
175 dbmail-users -x bar@domain -t "!cat > /var/spool/mail/bar/whatever.mbox"
177 Forwards can be listed using the same -l command as for users. For
179 example, to see where the local address bar@domain[2] might be
180 forwarded to, use this:
181 dbmail-users -l bar@domain
183 forward [bar@domain] to [bar@another.domain]
184 forward [bar@domain] to [|/usr/sbin/superspamtrapper]
185 forward [bar@domain] to [!cat > /var/spool/mail/bar/whatever.mbox]
186 Forwards can be removed using basic glob style pattern matching. A ?
188 question means "match zero or one of any character" and * asterisk
189 means "match zero or more of any character." For example:
190 dbmail-users -x bar@domain -T "*"
192 will complete and totally remove the bar@domain external alias and all
194 of its forwarding addresses and commands.
195
197 If you experience inexplicable problems with DBMail, please report the
198 issue to the DBMail Bug Tracker[3].
199
201 DBMail and its components are distributed under the terms of the GNU
202 General Public License. Copyrights are held variously by the authors
203 listed below.
204
206 DBMail is a collaborative effort among the core developers listed below
207 and the tremendous help of the testers, patchers and bug hunters listed
208 in the AUTHORS and THANKS files found in the DBMail source
209 distribution.
210 Eelco van Beek Aaron Stone Paul J Stevens
212 Roel Rozendaal Open Source Engineer NFG Net Facilities Group BV
213 Ilja Booij Palo Alto, CA USA http://www.nfg.nl
214 IC&S http://hydricacid.com
215 Koningsweg 4
216 3582 GE Utrecht
217 http://www.ic-s.nl
218
220 1. dbmail@dbmail.org
221 mailto:dbmail@dbmail.org
222 2. bar@domain
224 mailto:bar@domain
225 3. DBMail Bug Tracker
227 http://dbmail.org/index.php?page=bugs
228 08/10/2010 DBMAIL-USERS(8)