doveadm-index(1)

NAME

   doveadm-index - Index mailboxes

SYNOPSIS

   doveadm [-Dv] index [-S socket_path] [-q] [-n max_recent] mailbox
   doveadm [-Dv] index [-S socket_path] -A [-q] [-n max_recent] mailbox
   doveadm  [-Dv]  index  [-S  socket_path]  -F  file [-q] [-n max_recent]
   mailbox
   doveadm [-Dv] index  [-S  socket_path]  -u user  [-q]  [-n  max_recent]
   mailbox

DESCRIPTION

   Add unindexed messages in a mailbox into index/cache file. If full text
   search is enabled, also add unindexed messages to the fts database.

   The caching adds only the fields that  were  previously  added  to  the
   mailbox's  caching  decisions,  so  it  won't  do  anything  useful for
   mailboxes that user's client hasn't accessed yet. You can  use  doveadm
   dump command to show a specific mailbox's current caching decisions.

   Messages  can  also  be  added  automatically to full text search index
   using:

   plugin {
     ...
     fts_autoindex = yes
   }
   in /etc/dovecot/conf.d/90-plugin.conf.

OPTIONS

   Global doveadm(1) options:

   -D     Enables verbosity and debug messages.

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

   -n max_recent
          An integer value, which specifies the maximum number of  \Recent
          messages  in  mailboxes.   If  the  mailbox  contains  more than
          max_recent messages with \Recent flag set, the mailbox will  not
          be  indexed.   This  may be useful to avoid unnecessary indexing
          for large mailboxes that are never opened.

   -q     Queues the indexing to be run by indexer  process.   Without  -q
          the  indexing  is done directly by the doveadm(1) process.  Some
          backends  like  fts-lucene  can't  handle   multiple   processes
          updating  the  indexes  simultaneously,  so -q should usually be
          used on production.

   -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).
          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
          The name of the mailbox to index.

EXAMPLE

   Index bob's INBOX:

   doveadm index -u bob INBOX

REPORTING BUGS

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

SEE ALSO

   doveadm(1)

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.