doveadm-dump(1)

1DOVEADM-DUMP(1)                     Dovecot                    DOVEADM-DUMP(1)
2
3
4

NAME

6       doveadm-dump - Dump the content of Dovecot's binary mailbox index/log
7

SYNOPSIS

9       doveadm [-Dv] dump [-t type] path
10

DESCRIPTION

12       Dovecot  uses  several  binary  index and log files in order to improve
13       performance for accessing mails. For  some  mailbox  formats,  such  as
14       sdbox  and  mdbox,  the index files are part of the format itself.  For
15       details about index files,  see  also:  http://wiki2.dovecot.org/Index‐
16       Files
17
18       doveadm  dump  is  used to show the contents of those mailbox index/log
19       files, in human readable format. This  is  mainly  useful  for  Dovecot
20       developers when debugging some problem.
21

OPTIONS

23       Global doveadm(1) options:
24
25       -D     Enables verbosity and debug messages.
26
27       -o setting=value
28              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
29              cot.conf and from the userdb with the given value.  In order  to
30              override  multiple settings, the -o option may be specified mul‐
31              tiple times.
32
33       -v     Enables verbosity, including progress counter.
34
35       Command specific options:
36
37       -t type
38              the file type of the file to be dumped.  If the type  was  omit‐
39              ted, doveadm(1) tries to detect the type of path.  type can be:
40
41              dbox        ⇒ m.n (sdbox or mdbox mailbox file)
42
43              fts-expunge-log
44                          Dump   the   list   of   expunged   mails  in  dove‐
45                          cot-expunges.log.    Currently    used    only    by
46                          fts-lucene.
47
48              fts-lucene  Dump  the  list  of  indexed mails in lucene-indexes
49                          directory
50
51              imapzlib    Uncompress an IMAP traffic log, which contains  data
52                          compressed using the IMAP COMPRESSION extension.
53
54              dcrypt-file Dump metadata of a dcrypt encrypted file.
55
56              dcrypt-key  Dump metadata of a dcrypt key.
57
58              index       ⇒ dovecot.index, dovecot.map.index
59
60              log         ⇒ dovecot.index.log, dovecot.map.index.log
61
62              mailboxlog  ⇒ dovecot.mailbox.log
63
64              thread      ⇒ dovecot.index.thread
65

ARGUMENTS

67       path   The  path  to the corresponding dbox storage, index or log file.
68              If only a directory is specified, doveadm tries  to  detect  the
69              type of files under it and dumps them.
70

EXAMPLE

72       Look at the contents of a mailbox's index:
73
74       doveadm dump ~/Maildir/.work/
75

REPORTING BUGS

77       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
78       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
79       at: http://dovecot.org/bugreport.html
80