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
50 Create an external forwarding address
51
53 -w passwd
54 Specify user's password on the command line
55 -W [file]
57 Read from a file or prompt for a user's password
58 -p pwtype
60 Password type may be one of the following: plaintext, crypt,
61 md5-hash, md5-digest, crypt-raw, md5-hash-raw, md5-digest-raw,
62 md5-base64, md5-base64-raw.
63 -P [file]
65 Pull encrypted password from the shadow file
66 -u user
68 New username (only useful for -c, change)
69 -g cid
71 Assign the user to a client group.
72 -m max
74 Set the maximum mail quota in <bytes>B, <kbytes>K, or <mbytes>M,
75 default in bytes If set to 0, there will be no limit.
76 -s alias[,alias...]
78 Adds a list of recipient aliases. An alias is an e-mail address that
79 is being delivered to the DBMail mailsystem and should be delivered
80 to this user.
81 -S alias[,alias...]
83 Removes a list of recipient aliases. Use wildcards ? and * to match
84 any single character and any number of characters, respectively.
85 -t forward[,forward...]
87 Adds a list of deliver-to forwards.
88 -T forward[,forward...]
90 Removes a list of deliver-to forwards. Use wildcards ? and * to
91 match any single character and any number of characters,
92 respectively.
93
95 -f configfile
96 Specify an alternate config file. The utilities are currently
97 hardcoded to use /etc/dbmail.conf for their configs, and will halt
98 if the config file cannot be found. Use the -f configfile option to
99 specify your system's preferred config file location.
100 -q
102 Quietly skip interactive prompts and helpful status messages which
103 would otherwise be printed to stdout. Use two -q's to silence errors
104 which would otherwise be printed to stderr.
105 -v
107 Operate verbosely. Some of the utilities in the DBMail suite can
108 take two -v's for extra verbosity. Those which don't understand this
109 convention won't complain about having the extra -v and will simply
110 operate at their normal verbosity.
111 -V
113 Show the version and copyright, then exit.
114 -h
116 Show a brief summary of options, then exit.
117
119 One question we often see on the dbmail@dbmail.org mailing list is what
120 the difference is between aliases and forwards. When using
121 dbmail-users, the different command line options are there because an
122 alias attaches some arbitrary address to a particular user's account,
123 while a forward attaches some arbitrary address another arbitrary
124 address or pipe out.
125 When using dbmail-users with major option -c, you must use minor option
127 -s/-S for modifying aliases. When using dbmail-users with major option
128 -x, you must use -t/-T for modifying forwards.
129
131 When creating a new user account, you must either add an initial alias
132 that delivers to the account name, or make the account in the form of a
133 fully qualified email address. For example, the user named Baz created
134 like this:
135 dbmail-users -a baz -p crypt -w psword
137 will not actually receive any mail yet! You must be sure to add an
139 alias:
140 dbmail-users -c baz -s baz@foodomain
142 You may add multiple aliases by repeatedly calling the dbmail-users(8)
144 utility, or by calling it with a comma-separated list of aliases:
145 dbmail-users -c baz -s baz@foodomain,baz@bardomain
147 Three catch-all modes are also supported, for domains, sub-domains, and
149 local parts:
150 dbmail-users -a baz -s @bazdomain
152 dbmail-users -a baz -s @.allsubs.bazdomain
154 dbmail-users -a baz -s baz@
156 The first example catches email addressed to any user @bazdomain and
158 delivers it to Baz's INBOX. The second example catch email address to
159 any user at any subdomain below .allsubs.bazdomain (not including
160 allsubs.bazdomain itself!) The third example catches email addressed to
161 baz@ at any domain.
162 There is no support for delivering to a particular mailbox other than
164 INBOX via the aliases system. Please use a Sieve script to sort mail
165 like this.
166
168 Incoming messages addressed to particular email addresses can be
169 forwarded out to outside email addresses, piped out to a command (when
170 prepended with | pipe) or piped out with an mbox-style From line to a
171 command (when prepended with ! bang). For example:
172 dbmail-users -x bar@domain -t bar@another.domain
174 dbmail-users -x bar@domain -t "|/usr/sbin/superspamtrapper"
176 dbmail-users -x bar@domain -t "!cat > /var/spool/mail/bar/whatever.mbox"
178 Forwards can be listed using the same -l command as for users. For
180 example, to see where the local address bar@domain might be forwarded
181 to, use this:
182 dbmail-users -l bar@domain
184 forward [bar@domain] to [bar@another.domain]
185 forward [bar@domain] to [|/usr/sbin/superspamtrapper]
186 forward [bar@domain] to [!cat > /var/spool/mail/bar/whatever.mbox]
187 Forwards can be removed using basic glob style pattern matching. A ?
189 question means "match zero or one of any character" and * asterisk
190 means "match zero or more of any character." For example:
191 dbmail-users -x bar@domain -T "*"
193 will complete and totally remove the bar@domain external alias and all
195 of its forwarding addresses and commands.
196
198 If you experience inexplicable problems with DBMail, please report the
199 issue to the [1]DBMail Bug Tracker.
200
202 DBMail and its components are distributed under the terms of the GNU
203 General Public License. Copyrights are held variously by the authors
204 listed below.
205
207 DBMail is a collaborative effort among the core developers listed below
208 and the tremendous help of the testers, patchers and bug hunters listed
209 in the AUTHORS and THANKS files found in the DBMail source
210 distribution.
211 Eelco van Beek Aaron Stone Paul J Stevens
213 Roel Rozendaal Open Source Engineer NFG Net Facilities Group BV
214 Ilja Booij Palo Alto, CA USA http://www.nfg.nl
215 IC&S http://hydricacid.com
216 Koningsweg 4
217 3582 GE Utrecht
218 http://www.ic-s.nl
219
222 1. DBMail Bug Tracker
223 http://dbmail.org/index.php?page=bugs
224 12/27/2007 DBMAIL-USERS(8)