doveadm-mailbox


SYNOPSIS
       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.

       -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  iter-
              ate_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.  Oth-
              erwise doveadm(1) will be unable to iterate over all users.

       -S socket_path
              The option's 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.  It's also possible  to
              use '*' and '?' wildcards (e.g. -u *@example.org).

COMMANDS
   mailbox create
       doveadm mailbox create [-A|-u user] [-S socket_path] [-s] mailbox ...

       This command is used to create one or more mailboxes.  The mailbox for-
       mat of the created mailboxes depends on the mail_location  setting,  or
       the user's mail field, returned by the userdb.

       When  the -s option was given, the created mailboxes will be also added
       to the user's subscriptions.

   mailbox delete
       doveadm mailbox delete [-A|-u user] [-S socket_path] [-s] mailbox ...

       This command deletes a mailbox and expunges all the  messages  it  con-
       tains.  If the mailbox has any children, they won't 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] [-S socket_path] [-s]  [mail-
       box ...]

       To  get  an overview of existing mailboxes use this command.  It's 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  Con-
       vention).

       -7     Indicates  that  the  name's  string  representation  is  mUTF-7
              encoded and it should be converted to UTF-8.

       -8     Indicates that the name's is UTF-8 encoded and  should  be  con-
              verted to mUTF-7 (default).

       name   One or more mailbox names that should be converted.

   mailbox rename
       doveadm  mailbox  rename  [-A|-u  user]  [-S socket_path] [-s] old_name
       new_name

       The mailbox rename command is used to rename the  mailbox  old_name  to
       -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's 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 \Recent 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's virtual size, computed with CRLF line ter-
                     minators.

   mailbox subscribe
       doveadm mailbox subscribe [-A|-u user] [-S socket_path] mailbox ...

       This command is used to subscribe one or more mailboxes.

   mailbox unsubscribe
       doveadm mailbox unsubscribe [-A|-u user] [-S socket_path] mailbox ...

       This command is used to unsubscribe one or more mailboxes.

EXAMPLE
       List subscribed mailboxes, beginning with 'dovecot', 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 bob's dovecot mailboxes.

       ~peter/mail/&U,BTFw-/&ZeVnLIqe-

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

SEE ALSO
       doveadm(1)



Dovecot v2.0                      2010-11-25                DOVEADM-MAILBOX(1)
Man Pages Copyright Respective Owners. Site Copyright (C) 1994 - 2017 Hurricane Electric. All Rights Reserved.