DOVEADM-DUMP(1)
π DOVEADM-DUMP β the manual page, bestie edition π
okay so this is the page for doveadm-dump, which lives in the Dovecot fam (man page section 1, obvs). Sit down, grab a strawberry π, and let's get into it.
β¨ NAME β¨
doveadm-dump β dump the content of Dovecot's binary mailbox index/log. that's it. that's the whole job. π
πΈ SYNOPSIS πΈ
doveadm [GLOBAL OPTIONS] dump [-t type] path [type-specific args]
π¦ DESCRIPTION π¦
So Dovecot keeps a whole bunch of binary index and log files around, right? Not for fun β it's for performance, so accessing your mails is fast. Iconic behaviour honestly.
And for some mailbox formats β think sdbox and mdbox β those index files aren't just side quests, they're literally part of the format itself. For all the deets about index files, see [[link,design_index_format_main].
Now, doveadm dump is the tool that shows you what's inside those mailbox index/log files, but in human readable format. Who's she? πββοΈ
lowkey this is mainly for Dovecot developers debugging some problem. It's giving very much "for the girlies writing the code" energy. But if you're reading this, you're probably one of them, so slay. π
π GLOBAL OPTIONS π
these are the global doveadm(1) options, the shared starter pack everyone gets:
-Dβ Enables verbosity and debug messages. she's chatty and she's proud. π£οΈ-Oβ Do not read any config file, just use defaults. Thedovecot_storage_versionsetting defaults to the latest version, but can be overridden with-o. no cap, defaults only.-kβ Preserve entire environment fordoveadm, not just theimport_environmentsetting. keep the whole vibe, not a fragment. π«Ά-vβ Enables verbosity, including progress counter. numbers going up = serotonin. β¨-i instance-nameβ If using multiple Dovecot instances, choose the config file based on this instance name. See theinstance_namesetting for more information. multiple instances? pick your main character. π-c config-fileβ Read configuration from the givenconfig-file. By default it first reads the config socket, and then falls back to/etc/dovecot/dovecot.conf. You can also point this to a config socket of some instance running a compatible version. choose your own adventure, bestie. π-o setting=valueβ Overrides the configuration setting from/etc/dovecot/dovecot.confand from the userdb with the given value. In order to override multiple settings, the-ooption may be specified multiple times. stack 'em like bracelets. π
π OPTIONS π
-t typeβ the file type of the file to be dumped. If the type was omitted,doveadm(1)tries to detect the type ofpath. she'll figure it out herself, honestly.
type can be:
dbox : => m.n (sdbox or mdbox mailbox file)fts-expunge-log: Dump the list of expunged mails indovecot-expunges.log. π gone girl.fts-flatcurve: Dump the keywords indexed infts-flatcurveindexes directory and their frequencies.imap-compress: Decompress an IMAP traffic log, which contains data compressed using the IMAP COMPRESSION extension. unzip that gossip. π₯dcrypt-file: Dump metadata of a dcrypt encrypted file.
type-specific args
private_key=/path: to decrypt file contents.password=secret: to decrypt private key.
dcrypt-key: Dump metadata of a dcrypt key.
type-specific args
private_key=/path- to decrypt file contents.
password=secret- to decrypt private key.
dump=pem|dovecot|jwk- to specify format to dump in.
index : => dovecot.index, dovecot.map.index
type-specific args
uid=number: Dump only message with UID
log : => dovecot.index.log, dovecot.map.index.logmailboxlog : => dovecot.mailbox.logthread : => dovecot.index.thread
π§ ARGUMENTS π§
pathβ The path to the corresponding dbox storage, index or log file. If only a directory is specified,doveadmtries to detect the type of files under it and dumps them. yes bestie, it'll go digging through the whole directory for you. π
β EXAMPLE β
Look at the contents of a mailbox's index:
doveadm dump ~/Maildir/.work/
ate. no crumbs. π½οΈ
π REPORTING BUGS π
Report bugs, including doveconf -n output, to the Dovecot Mailing List β¨dovecot@dovecot.orgβ©. Information about reporting bugs is available at: β¨https://dovecot.org/bugreport.htmlβ©
pls include your doveconf -n output, the devs need the full tea to help you. π« don't be shy, they're nice.
π SEE ALSO π
and that's the whole page, bestie!! π this manual page is from the Dovecot fam, version f979264, dated April 2026. go dump some indexes, you got this. πβ¨π¦
π¦ where this page comes from
- alpine 3.23: dovecot-doc 2.4.5-r0 Β· MIT AND LGPL-2.1-or-later
- alpine 3.24: dovecot-doc 2.4.5-r0 Β· MIT AND LGPL-2.1-or-later
- arch rolling: dovecot 2.4.5-1 Β· MIT AND LGPL-2.1-only
- fedora 43: dovecot 1:2.4.5-1.fc43 Β· MIT AND LGPL-2.1-only
- fedora 44: dovecot 1:2.4.5-1.fc44 Β· MIT AND LGPL-2.1-only
- nixos 26.05: dovecot 2.4.5
- nixpkgs unstable: dovecot 2.4.5
- opensuse-leap 16.0: dovecot24 2.4.5-160000.1.1 Β· BSD-3-Clause AND LGPL-2.1-or-later AND MIT
- opensuse-leap 16.0: dovecot24 2.4.5-160000.1.1 Β· BSD-3-Clause AND LGPL-2.1-or-later AND MIT
- opensuse-leap 16.0: dovecot24 2.4.5-160000.1.1 Β· BSD-3-Clause AND LGPL-2.1-or-later AND MIT
- opensuse-leap 16.0: dovecot24 2.4.5-160000.1.1 Β· BSD-3-Clause AND LGPL-2.1-or-later AND MIT
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms