1DBMAIL-UTIL(8) DBMAIL-UTIL(8)
2
6 dbmail-util - maintains the integrity and cleanliness of the DBMail
7 datatables.
8
10 dbmail-util [-actubpds] [-l time] [-yn] [-qvVh] [-f configFile]
11
13 The dbmail-util program does a global database cleanup and integrity
14 check. All messages that are set for deletion will be marked for final
15 deletion (status 3). All message that are marked for final deletion
16 will be cleared from the database. The integrity check will check for
17 unconnected messageblocks, unconnected messages and unconnected
18 mailboxes.
19 By default, the checks run in a read-only mode, possibly prompting to
21 make changes. Pass the -n option to respond no to any prompts. Pass the
22 -y option to make read-write changes, responding yes to any prompts.
23 As DBMail matures and new features are added, additional check modes
25 will be added. In addition, more prompts may be added for different
26 situations where changes need to be committed to the database. We
27 recommend using the -a option to run all checks and using the -n and -y
28 options if you expect no prompts.
29
31 -a
32 Perform all checks listed below. This option will be kept up-to-date
33 with additional checks available in future versions.
34 -c
36 Clean up unlinked message entries.
37 -t
39 Test for message integrity.
40 -u
42 Null message check.
43 -b
45 Check and rebuild the body/header/envelope cache tables.
46 -p
48 Purge messages with DELETE status. To purge messages currently
49 marked \Deleted, run with the -pd options twice. This is not
50 recommended; it is better to leave a grace period for old messages
51 before permanently wiping them from the database.
52 -d
54 Set DELETE status for messages flagged \Deleted by IMAP or POP3.
55 -s
57 Remove dangling/invalid aliases and forwards.
58 -r time
60 Clear the reply cache used for autoreplies and Sieve vacations. The
61 time is specified as <hours>h<minutes>m (don't include the angle
62 brackets, though!).
63 -l time
65 Clear the IP log used for IMAP/POP-before-SMTP. The time is
66 specified as <hours>h<minutes>m (don't include the angle brackets,
67 though!).
68 -n
70 Show the intended repairs without making any changes, i.e. no to
71 all.
72 -y
74 Perform all repair actions , i.e. yes to all.
75 -i
77 Enter an interactive user management console in some future version
78 where this feature is implemented. It is not currently available.
79
81 -f configfile
82 Specify an alternate config file. The utilities are currently
83 hardcoded to use /etc/dbmail.conf for their configs, and will halt
84 if the config file cannot be found. Use the -f configfile option to
85 specify your system's preferred config file location.
86 -q
88 Quietly skip interactive prompts and helpful status messages which
89 would otherwise be printed to stdout. Use two -q's to silence errors
90 which would otherwise be printed to stderr.
91 -v
93 Operate verbosely. Some of the utilities in the DBMail suite can
94 take two -v's for extra verbosity. Those which don't understand this
95 convention won't complain about having the extra -v and will simply
96 operate at their normal verbosity.
97 -V
99 Show the version and copyright, then exit.
100 -h
102 Show a brief summary of options, then exit.
103
105 Returns 3 when errors are found but could not be fixed due to failure,
106 2 when errors are found but -y was not provided or -n was provided, 1
107 when errors are found and fixed successfully, 0 when no errors are
108 found.
109
111 After upgrading from DBMail 2.0, run this command to populate the cache
112 tables:
113 dbmail-util -by
115 To set all messages flagged \Deleted to the DELETE status, and to
117 permanently purge all messages previously set to DELETE status:
118 dbmail-util -dpy
120 To get a listing of the changes that would be performed for all
122 actions:
123 dbmail-util -an
125 To remove all IP log entries more than three days old:
127 dbmail-util -l 72h -y
129
131 If you experience inexplicable problems with DBMail, please report the
132 issue to the [1]DBMail Bug Tracker.
133
135 DBMail and its components are distributed under the terms of the GNU
136 General Public License. Copyrights are held variously by the authors
137 listed below.
138
140 DBMail is a collaborative effort among the core developers listed below
141 and the tremendous help of the testers, patchers and bug hunters listed
142 in the AUTHORS and THANKS files found in the DBMail source
143 distribution.
144 Eelco van Beek Aaron Stone Paul J Stevens
146 Roel Rozendaal Open Source Engineer NFG Net Facilities Group BV
147 Ilja Booij Palo Alto, CA USA http://www.nfg.nl
148 IC&S http://hydricacid.com
149 Koningsweg 4
150 3582 GE Utrecht
151 http://www.ic-s.nl
152
155 1. DBMail Bug Tracker
156 http://dbmail.org/index.php?page=bugs
157 10/16/2007 DBMAIL-UTIL(8)