doveadm-mailbox(1)

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

NAME

6       doveadm-mailbox - Commands related to handling mailboxes
7

SYNOPSIS

9       doveadm [-Dv] [-f formatter] mailbox_cmd [options] [arguments]
10

DESCRIPTION

12       doveadm mailbox can be used to query and modify mailboxes.
13

OPTIONS

15       Global doveadm(1) options:
16
17       -D     Enables verbosity and debug messages.
18
19       -f formatter
20              Specifies  the  formatter  for formatting the output.  Supported
21              formatters are:
22
23              flow   prints each line with key=value pairs.
24
25              pager  prints each key: value pair on its own line and separates
26                     records with form feed character (^L).
27
28              tab    prints  a  table  header  followed by tab separated value
29                     lines.
30
31              table  prints a table header followed by adjusted value lines.
32
33       -v     Enables verbosity, including progress counter.
34
35       Command specific options:
36
37       -A     If the -A option is present, the command will be  performed  for
38              all  users.   Using this option in combination with system users
39              from userdb { driver = passwd } is not recommended,  because  it
40              contains  also  users  with  a lower UID than the one configured
41              with the first_valid_uid setting.
42
43              When the SQL userdb module is used  make  sure  that  the  iter‐
44              ate_query  setting  in /etc/dovecot/dovecot-sql.conf.ext matches
45              your database layout.  When using the LDAP userdb  module,  make
46              sure  that  the  iterate_attrs  and  iterate_filter  settings in
47              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
48              erwise doveadm(1) will be unable to iterate over all users.
49
50       -S socket_path
51              The option's argument is either an absolute path to a local UNIX
52              domain socket, or a hostname and port (hostname:port), in  order
53              to connect a remote host via a TCP socket.
54
55              This allows an administrator to execute doveadm(1) mail commands
56              through the given socket.
57
58       -u user/mask
59              Run the command only for the given user.  It's also possible  to
60              use '*' and '?' wildcards (e.g. -u *@example.org).
61              When  neither  the -A option nor -u user was specified, the com‐
62              mand will be executed with  the  environment  of  the  currently
63              logged in user.
64

ARGUMENTS

66       mailbox
67              Is  the name of a mailbox, as visible to IMAP clients, except in
68              UTF-8 format. The hierarchy separator between a parent and child
69              mailbox  is  commonly  '/'  or  '.',  but  this  depends on your
70              selected mailbox storage format and namespace configuration. The
71              mailbox names may also require a namespace prefix.
72

COMMANDS

74   mailbox create
75       doveadm mailbox create [-A|-u user] [-S socket_path] [-s] mailbox ...
76
77       This command is used to create one or more mailboxes.  The mailbox for‐
78       mat of the created mailboxes depends on the mail_location  setting,  or
79       the user's mail field, returned by the userdb.
80
81       When  the -s option was given, the created mailboxes will be also added
82       to the user's subscriptions.
83
84   mailbox delete
85       doveadm mailbox delete [-A|-u user] [-S socket_path] [-s] mailbox ...
86
87       This command deletes a mailbox and expunges all the  messages  it  con‐
88       tains.  If the mailbox has any children, they won't be deleted.
89       When  the  -s  option  is  present,  the deleted mailboxes will be also
90       unsubscribed.
91
92   mailbox list
93       doveadm mailbox list [-7|-8] [-A|-u user] [-S socket_path] [-s]  [mail‐
94       box ...]
95
96       To  get  an overview of existing mailboxes use this command.  It's also
97       possible to use wildcards in the mailbox name.
98       When the -s option  is  present,  only  subscribed  mailboxes  will  be
99       listed.  Listed  subscriptions  may  also  contain  mailboxes  that are
100       already deleted.
101
102       -7     Lists the mailboxes with mUTF-7 encoding.
103
104       -8     Lists the mailboxes with UTF-8 encoding.
105
106   mailbox mutf7
107       doveadm mailbox mutf7 [-7|-8] name ...
108
109       The mailbox mutf7 command may be  used  to  convert  the  international
110       mailbox  name  into  a  modified version of the UTF-7 encoding and vice
111       versa.  See RFC 3501, section 5.1.3 (Mailbox International Naming  Con‐
112       vention).
113
114       -7     Indicates  that  the  name's  string  representation  is  mUTF-7
115              encoded and it should be converted to UTF-8.
116
117       -8     Indicates that the name's is UTF-8 encoded and  should  be  con‐
118              verted to mUTF-7 (default).
119
120       name   One or more mailbox names that should be converted.
121
122   mailbox rename
123       doveadm  mailbox  rename  [-A|-u  user]  [-S socket_path] [-s] old_name
124       new_name
125
126       The mailbox rename command is used to rename the  mailbox  old_name  to
127       new_name.
128       When the -s option is given, old_name will be unsubscribed and new_name
129       will be subscribed.
130
131   mailbox status
132       doveadm [-f formatter] mailbox status  [-A|-u  user]  [-S  socket_path]
133       [-t] fields mailbox ...
134
135       Show  the  status  of one or more mailboxes.  The mailbox name may also
136       contain wildcards.
137       This command uses by default the output formatter flow.
138
139       -t     Summarize the values of  the  status  fields  messages,  recent,
140              unseen and/or vsize of multiple mailboxes to a sum (total).
141
142       fields Specify  the  status  fields which should be shown.  In order to
143              specify multiple status fields, enclosed them in quotes.
144
145              all    This is a special status field name.  It means  show  all
146                     of  the following fields.  When the -t option is present,
147                     it means show only the messages, recent, unseen and vsize
148                     fields.
149
150              guid   The mailbox's globally unique identifier.
151
152              highestmodseq
153                     The  highest  mod-sequence  value  of all messages in the
154                     mailbox.
155
156              messages
157                     The number of messages in the mailbox.
158
159              recent The number of messages with the \Recent flag set.
160
161              uidnext
162                     The next unique identifier value.
163
164              uidvalidity
165                     The unique identifier validity value.
166
167              unseen The message sequence number of the first  unseen  message
168                     in the mailbox.
169
170              vsize  The  mailbox's virtual size, computed with CRLF line ter‐
171                     minators.
172
173   mailbox subscribe
174       doveadm mailbox subscribe [-A|-u user] [-S socket_path] mailbox ...
175
176       This command is used to subscribe one or more mailboxes.
177
178   mailbox unsubscribe
179       doveadm mailbox unsubscribe [-A|-u user] [-S socket_path] mailbox ...
180
181       This command is used to unsubscribe one or more mailboxes.
182

EXAMPLE

184       List subscribed mailboxes, beginning with 'dovecot', of user bob.
185
186       doveadm mailbox list -s -u bob dovecot*
187       dovecot
188       dovecot/pigeonhole
189       dovecot/pigeonhole/2.0
190
191       Now have a look at the status of user bob's dovecot mailboxes.
192
193       doveadm -f table mailbox status -u bob "messages vsize" dovecot*
194       mailbox                                    messages vsize
195       dovecot                                    20501    93968492
196       dovecot/pigeonhole                         0        0
197       dovecot/pigeonhole/2.0                     47       323474
198
199       Converting an internationalized mailbox name from mUTF-7 to  UTF-8  and
200       vice versa.
201
202       doveadm mailbox mutf7 -7 "~peter/mail/&U,BTFw-/&ZeVnLIqe-"
203       ~peter/mail/台北/日本語
204       doveadm mailbox mutf7 ~peter/mail/台北/日本語
205       ~peter/mail/&U,BTFw-/&ZeVnLIqe-
206

REPORTING BUGS

208       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
209       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
210       at: http://dovecot.org/bugreport.html
211