doveadm-mailbox (1)
Leading comments
Copyright (c) 2010-2016 Dovecot authors, see the included COPYING file
NAME
doveadm-mailbox - Commands related to handling mailboxesSYNOPSIS
doveadm [-Dv] [-f formatter] mailbox_cmd [options] [arguments]DESCRIPTION
doveadm mailbox can be used to query and modify mailboxes.OPTIONS
Global doveadm(1) options:- -D
- Enables verbosity and debug messages.
- -f formatter
-
Specifies the
formatter
for formatting the output.
Supported formatters are:
-
- flow
- prints each line with key=value pairs.
- pager
- prints each key: value pair on its own line and separates records with form feed character (^L).
- tab
- prints a table header followed by tab separated value lines.
- table
- prints a table header followed by adjusted value lines.
-
- -o setting=value
- Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.
- -v
- Enables verbosity, including progress counter.
Command specific options:
- -A
-
If the
-A
option is present, the
command
will be performed for all users.
Using this option in combination with system users from
userdb { driver = passwd }
is not recommended, because it contains also users with a lower UID than
the one configured with the
first_valid_uid
setting.
When the SQL userdb module is used make sure that the iterate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches your database layout. When using the LDAP userdb module, make sure that the iterate_attrs and iterate_filter settings in /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.
- -F file
- Execute the command for all the users in the file. This is similar to the -A option, but instead of getting the list of users from the userdb, they are read from the given file. The file contains one username per line.
- -S socket_path
-
The optionaqs argument is either an absolute path to a local UNIX domain
socket, or a hostname and port
(hostname:port),
in order to connect a remote host via a TCP socket.
This allows an administrator to execute doveadm(1) mail commands through the given socket.
- -u user/mask
-
Run the
command
only for the given
user.
Itaqs also possible to use
aq*aq
and
aq?aq
wildcards (e.g. -u *@example.org).
When neither the -A option, nor the -F file option, nor the -u user was specified, the command will be executed with the environment of the currently logged in user.
ARGUMENTS
- mailbox
- Is the name of a mailbox, as visible to IMAP clients, except in UTF-8 format. The hierarchy separator between a parent and child mailbox is commonly aq/aq or aq.aq, but this depends on your selected mailbox storage format and namespace configuration. The mailbox names may also require a namespace prefix.
COMMANDS
mailbox create
doveadm mailbox create [-A|-u user|-F file] [-S socket_path] [-g guid] [-s] mailbox ...This command is used to create one or more mailboxes. The mailbox format of the created mailboxes depends on the mail_location setting, or the useraqs mail field, returned by the userdb.
- -g guid
- Create the mailbox with the specified GUID.
- -s
- When this option was given, the created mailboxes will be also added to the useraqs subscriptions.
mailbox cryptokey
mailbox cryptokey export|generate|list|passwordThis command is used to manage mail crypt plugin cryptographic keys. Please see doveadm-mailbox-cryptokey(1) for more details.
mailbox delete
doveadm mailbox delete [-A|-u user|-F file] [-S socket_path] [-s] mailbox ...
This command deletes a mailbox and expunges all the messages it contains.
If the mailbox has any children, they wonaqt be deleted.
When the
-s
option is present, the deleted mailboxes will be also unsubscribed.
mailbox list
doveadm mailbox list [-7|-8] [-A|-u user|-F file] [-S socket_path] [-s] [mailbox ...]
To get an overview of existing mailboxes use this command.
Itaqs also possible to use wildcards in the
mailbox
name.
When the
-s
option is present, only subscribed mailboxes will be listed. Listed
subscriptions may also contain mailboxes that are already deleted.
- -7
- Lists the mailboxes with mUTF-7 encoding.
- -8
- Lists the mailboxes with UTF-8 encoding.
mailbox mutf7
doveadm mailbox mutf7 [-7|-8] name ...The mailbox mutf7 command may be used to convert the international mailbox name into a modified version of the UTF-7 encoding and vice versa. See RFC 3501, section 5.1.3 (Mailbox International Naming Convention).
- -7
- Indicates that the nameaqs string representation is mUTF-7 encoded and it should be converted to UTF-8.
- -8
- Indicates that the nameaqs is UTF-8 encoded and should be converted to mUTF-7 (default).
- name
- One or more mailbox names that should be converted.
mailbox rename
doveadm mailbox rename [-A|-u user|-F file] [-S socket_path] [-s] old_name new_name
The
mailbox rename
command is used to rename the mailbox
old_name
to
new_name.
When the
-s
option is given,
old_name
will be unsubscribed
and
new_name
will be subscribed.
mailbox status
doveadm [-f formatter] mailbox status [-A|-u user|-F file] [-S socket_path] [-t] fields mailbox ...
Show the
status
of one or more mailboxes.
The
mailbox
name may also contain wildcards.
This command uses by default the output
formatter
flow.
- -t
- Summarize the values of the status fields messages, recent, unseen and/or vsize of multiple mailboxes to a sum (total).
- fields
-
Specify the status
fields
which should be shown.
In order to specify multiple status
fields,
enclosed them in quotes.
-
- all
- This is a special status field name. It means show all of the following fields. When the -t option is present, it means show only the messages, recent, unseen and vsize fields.
- guid
- The mailboxaqs globally unique identifier.
- highestmodseq
- The highest mod-sequence value of all messages in the mailbox.
- messages
- The number of messages in the mailbox.
- recent
- The number of messages with the rsRecent flag set.
- uidnext
- The next unique identifier value.
- uidvalidity
- The unique identifier validity value.
- unseen
- The message sequence number of the first unseen message in the mailbox.
- vsize
- The mailboxaqs virtual size, computed with CRLF line terminators.
-
mailbox subscribe
doveadm mailbox subscribe [-A|-u user|-F file] [-S socket_path] mailbox ...This command is used to subscribe one or more mailboxes.
mailbox unsubscribe
doveadm mailbox unsubscribe [-A|-u user|-F file] [-S socket_path] mailbox ...This command is used to unsubscribe one or more mailboxes.
mailbox update
doveadm mailbox update [-A|-u user|-F] [-S socket_path] [--mailbox-guid guid] [--uid-validity uid] [--min-next-uid uid] [--min-first-recent-uid uid] [--min-highest-modseq seq] [--min-highest-pvt-modseq seq] mailbox ...This command is used to set UID validity, next UID, first recent UID and modification sequence values.
Usually this is only ever to be used during migration, or restoring mailbox after disaster. Settings these values is highly discouraged, and is not supported for all mail backends.
EXAMPLE
List subscribed mailboxes, beginning with aqdovecotaq, of user bob.
doveadm mailbox list -s -u bob dovecot* dovecot dovecot/pigeonhole dovecot/pigeonhole/2.0
Now have a look at the status of user bobaqs dovecot mailboxes.
doveadm -f table mailbox status -u bob dqmessages vsizedq dovecot* mailbox messages vsize dovecot 20501 93968492 dovecot/pigeonhole 0 0 dovecot/pigeonhole/2.0 47 323474
Converting an internationalized mailbox name from mUTF-7 to UTF-8 and vice versa.
doveadm mailbox mutf7 -7 dq~peter/mail/&U,BTFw-/&ZeVnLIqe-dq ~peter/mail/台北/日本語 doveadm mailbox mutf7 ~peter/mail/台北/日本語 ~peter/mail/&U,BTFw-/&ZeVnLIqe-