NAMEdbmail-util - maintains the integrity and cleanliness of the DBMail datatables.
SYNOPSISdbmail-util [-actubpds] [-l time] [-yn] [-qvVh] [-f configFile]
DESCRIPTIONThe dbmail-util program does a global database cleanup and integrity check. All messages that are set for deletion will be marked for final deletion (status 3). All message that are marked for final deletion will be cleared from the database. The integrity check will check for unconnected messageblocks, unconnected messages and unconnected mailboxes. By default, the checks run in a read-only mode, possibly prompting to make changes. Pass the -n option to respond no to any prompts. Pass the -y option to make read-write changes, responding yes to any prompts. As DBMail matures and new features are added, additional check modes will be added. In addition, more prompts may be added for different situations where changes need to be committed to the database. We recommend using the -a option to run all checks and using the -n and -y options if you expect no prompts.
OPTIONS-a Perform all checks listed below. This option will be kept up-to-date with additional checks available in future versions. -c Clean up unlinked message entries. -t Test for message integrity. -u Null message check. -b Check and rebuild the body/header/envelope cache tables. -p Purge messages with DELETE status. To purge messages currently marked \Deleted, run with the -pd options twice. This is not recommended; it is better to leave a grace period for old messages before permanently wiping them from the database. -d Set DELETE status for messages flagged \Deleted by IMAP or POP3. -s Remove dangling/invalid aliases and forwards. -r time Clear the reply cache used for autoreplies and Sieve vacations. The time is specified as <hours>h<minutes>m (don't include the angle brackets, though!). -l time Clear the IP log used for IMAP/POP-before-SMTP. The time is specified as <hours>h<minutes>m (don't include the angle brackets, though!). -n Show the intended repairs without making any changes, i.e. no to all. -y Perform all repair actions , i.e. yes to all. -i Enter an interactive user management console in some future version where this feature is implemented. It is not currently available.
COMMON OPTIONS-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. -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. -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. -V Show the version and copyright, then exit. -h Show a brief summary of options, then exit.
RETURN VALUESReturns 3 when errors are found but could not be fixed due to failure, 2 when errors are found but -y was not provided or -n was provided, 1 when errors are found and fixed successfully, 0 when no errors are found.
EXAMPLESAfter upgrading from DBMail 2.0, run this command to populate the cache tables: dbmail-util -by To set all messages flagged \Deleted to the DELETE status, and to permanently purge all messages previously set to DELETE status: dbmail-util -dpy To get a listing of the changes that would be performed for all actions: dbmail-util -an To remove all IP log entries more than three days old: dbmail-util -l 72h -y
BUGSIf you experience inexplicable problems with DBMail, please report the issue to the DBMail Bug Tracker.
LICENSEDBMail and its components are distributed under the terms of the GNU General Public License. Copyrights are held variously by the authors listed below.
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. Eelco van Beek Aaron Stone Paul J Stevens Roel Rozendaal Open Source Engineer NFG Net Facilities Group BV Ilja Booij Palo Alto, CA USA //www.nfg.nl IC&S //hydricacid.com Koningsweg 4 3582 GE Utrecht //www.ic-s.nl
REFERENCES1. DBMail Bug Tracker //dbmail.org/index.php?page=bugs 10/16/2007 DBMAIL-UTIL(8)