DOVEADM-SEARCH(1) Dovecot DOVEADM-SEARCH(1)NAMEdoveadm-search - Show a list of mailbox GUIDs and message UIDs matching
given search query.
SYNOPSIS
doveadm [-Dv] [-f formatter] search [-S socket_path] search_query
doveadm [-Dv] [-f formatter] search [-S socket_path] -A search_query
doveadm [-Dv] [-f formatter] search [-S socket_path] -u user
search_query
DESCRIPTION
The search command is used to find matching messages. doveadm(1) will
print the mailbox's guid and the message's uid for each match.
When used with the -A or -u wildcard options, doveadm(1) will print the
fields username, mailbox-guid and uid for each matching message.
In the first form, doveadm(1) will executed the search action with the
environment of the logged in system user.
In the second form, the command will be performed for all users.
In the third form, only matching mails of the given user(s) will be
searched.
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.
This command uses by default the output formatter flow (without the
key= prefix).
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/opt/csw/dovecot/dovecot-sql.conf.ext
matches your database layout. When using the LDAP userdb mod‐
ule, make sure that the iterate_attrs and iterate_filter set‐
tings in /etc/opt/csw/dovecot/dovecot-ldap.conf.ext match your
LDAP schema. Otherwise 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).
When neither the -A option nor -u user was specified, the com‐
mand will be executed with the environment of the currently
logged in user.
ARGUMENTS
search_query
Show messages matching this search query. See
doveadm-search-query(7) for details.
EXAMPLE
This example demonstrates how to search in user bob's dovecot mailboxes
all messages, which contains the word "todo" in the Subject: header.
doveadm search -u bob mailbox dovecot\* subject todo
3a94c928d66ebe4bda04000015811c6a 8
3a94c928d66ebe4bda04000015811c6a 25
3a94c928d66ebe4bda04000015811c6a 45
The search command is mainly useful when used together with
doveadm fetch command. For example to save message bodies of all mes‐
sages from INBOX that have "todo" in subject, use:
doveadm search -u bob mailbox INBOX subject todo |
while read guid uid; do
doveadm fetch -u bob body mailbox-guid $guid uid $uid > msg.$uid
done
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 ALSOdoveadm(1), doveadm-fetch(1),
Dovecot v2.1 2010-11-25 DOVEADM-SEARCH(1)
