@INCLUDE:global-options-formatter@ --- command specific options --- "/.
Command specific
options : -------------------------------------
@INCLUDE:option-A@
-------------------------------------
@INCLUDE:option-F-file@
-------------------------------------
@INCLUDE:option-S-socket@
-------------------------------------
@INCLUDE:option-u-user@
------------------------------------------------------------------------
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.
------------------------------------------------------------------------
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 user\(aqs 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 user\(aqs
subscriptions.
------------------------------------------------------------------------
This command is used to manage mail crypt plugin cryptographic keys.
Please see doveadm-mailbox-cryptokey(1) for more details.
------------------------------------------------------------------------
This command deletes a mailbox and expunges all the messages it contains. If the mailbox has any children, they won\(aqt be deleted, unless -r is given.
-------------------------------------
-r Delete mailboxes recursively
-------------------------------------
-s Unsubscribe deleted mailboxes.
-------------------------------------
-e Require mailboxes to be empty before deleting.
-------------------------------------
-Z Delete the mailbox as efficiently as possible, but the user may not be in fully consistent state afterwards. For example quota may be wrong. This option is mainly useful when deleting the entire user.
------------------------------------------------------------------------
To get an overview of existing mailboxes use this command. It\(aqs 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.
------------------------------------------------------------------------
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
name \(aqs string representation is mUTF-7 encoded and it should be converted to
UTF-8.
-------------------------------------
-8 Indicates that the name \(aqs is UTF-8 encoded and should be converted to mUTF-7 (default).
name One or more mailbox names that should be converted.
------------------------------------------------------------------------
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.
------------------------------------------------------------------------
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 mailbox \(aqs 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 mailbox \(aqs virtual size, computed with CRLF line terminators.
firstsaved Saved time of the first mail in the mailbox.
------------------------------------------------------------------------
This command is used to subscribe one or more mailboxes.
------------------------------------------------------------------------
This command is used to unsubscribe one or more mailboxes.
------------------------------------------------------------------------
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.
------------------------------------------------------------------------
doveadm mailbox list -s -u bob dovecot* dovecot dovecot/pigeonhole dovecot/pigeonhole/2.0-------------------------------------
Now have a look at the status of user bob\(aqs dovecot mailboxes.
doveadm -f table mailbox status -u bob \(dqmessages vsize\(dq 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-------------------------------------------------------------------------
@INCLUDE:reporting-bugs@ ------------------------------------------------------------------------