This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 3 and 27 (spanning 24 versions)
Revision 3 as of 2010-07-13 02:42:42
Size: 5311
Editor: PageImporter
Comment:
Revision 27 as of 2021-09-22 07:08:19
Size: 6696
Editor: PageImporter
Comment:
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
<p><b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>]
<b>search
&nbsp;</b><i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>search -A</b> <i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>search -u</b> <i>user
search_query</i></p>
<p><b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>search</b> [<b>-S</b>
<i>socket_path</i>] <i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>search</b> [<b>-S</b>
<i>socket_path</i>] <b>-A</b><i>
&nbsp;search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>search</b> [<b>-S</b>
<i>socket_path</i>] <b>-F</b> <i>file
search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] [<b>-f</b> <i>formatter</i>] <b>search</b> [<b>-S</b>
<i>socket_path</i>] <b>
-u</b> <i>user search_query</i></p>
Line 23: Line 26:
<p>In the third form, only matching mails of the given <i>user</i>(s) will be searched.</p> <p>In the third form, the command will be performed for all users listed in the given
<i>file</i>.</p>
<p>In the fourth
form, only matching mails of the given <i>user</i>(s) will be searched.</p>
Line 27: Line 32:
<dt style="font-weight: bold">-D</dt> <dt><b>-D</b></dt>
Line 34: Line 39:
<dt style="font-weight: bold">flow</dt> <dt><b>flow</b></dt>
Line 36: Line 41:
<dt style="font-weight: bold">pager</dt> <dt><b>pager</b></dt>
Line 39: Line 44:
<dt style="font-weight: bold">tab</dt> <dt><b>tab</b></dt>
Line 41: Line 46:
<dt style="font-weight: bold">table</dt> <dt><b>table</b></dt>
Line 47: Line 52:
<dt style="font-weight: bold">-v</dt> <dt><b>-o&nbsp;</b><i>setting</i><b>=</b><i>value</i></dt>
<dd>Overrides the configuration <i>setting</i> from <i>/etc/dovecot/dovecot.conf</i> and from the
userdb with the given <i>value</i>. In order to override multiple settings, the <b>-o</b> option
may be specified multiple times.</dd>
<dt><b>-v</b></dt>
Line 54: Line 63:
<dt style="font-weight: bold">-A</dt> <dt><b>-A</b></dt>
Line 59: Line 68:
<p>When the sql userdb module is used make sure that the <i>iterate_query</i> setting in the
<i>@sysconfdir@/dovecot/dovecot-sql.conf.ext</i> matches your database layout. Otherwise
<b><a href="/Tools/Doveadm">doveadm</a></b>(1) will be unable to iterate over all users.</p>
<p>When the SQL userdb module is used make sure that the <i>iterate_query</i> setting in
<i>/etc/dovecot/dovecot-sql.conf.ext</i> matches your database layout. When using the LDAP userdb
module, make sure that the <i>iterate_attrs</i> and <i>iterate_filter</i> settings in
<i>/etc/dovecot/dovecot-ldap.conf.ext</i> match your LDAP schema. Otherwise <b><a href=
"/Tools/Doveadm">doveadm</a></b>(1) will be unable to iterate over all users.</p>
</dd>
<dt><b>-F&nbsp;</b><i>file</i></dt>
<dd>Execute the <i>command</i> for all the users in the <i>file</i>. This is similar to the
<b>-A</b> option, but instead of getting the list of users from the userdb, they are read from the
given <i>file</i>. The <i>file</i> contains one username per line.</dd>
<dt><b>-S&nbsp;</b><i>socket_path</i></dt>
<dd>The option&#39;s argument is either an absolute path to a local UNIX domain socket, or a
hostname and port (<i>hostname</i>:<i>port</i>), in order to connect a remote host via a TCP
socket.
<p>This allows an administrator to execute <b><a href="/Tools/Doveadm">doveadm</a></b>(1) mail
commands through the given socket.</p>
Line 66: Line 88:
When neither the <b>-A</b> option nor <b>-u&nbsp;</b><i>user</i> was specified, the <i>command</i>
will be executed with the environment of the currently logged in user.</dd>
When neither the <b>-A</b> option, nor the <b>-F&nbsp;</b><i>file</i> option, nor the
<b>-u&nbsp;</b><i>user</i> was specified, the <i>command</i> will be executed with the environment
of the currently logged in user.</dd>
Line 71: Line 94:
<dt style="font-style: italic">search_query</dt> <dt><i>search_query</i></dt>
Line 79: Line 102:
<b>doveadm search -u bob mailbox dovecot\* subject todo</b>
3a94c928d66ebe4bda04000015811c6a 8
<b>doveadm search -u bob mailbox dovecot\* subject todo
</b>3a94c928d66ebe4bda04000015811c6a 8
Line 88: Line 111:
<b>doveadm search -u bob mailbox INBOX subject todo |</b>
<b>while read guid uid; do</b>
<b> doveadm fetch -u bob body mailbox-guid $guid uid $uid &gt; msg.$uid</b>
<b>done</b>
</pre>
<b>doveadm search -u bob mailbox INBOX subject todo |
while read guid uid; do
  doveadm fetch -u bob body mailbox-guid $guid uid $uid &gt; msg.$uid
done
</b></pre>

Doveadm-Search

Name

doveadm-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] -F file 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, the command will be performed for all users listed in the given file.

In the fourth 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 keyvalue 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.

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

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

See Also

doveadm(1), doveadm-fetch(1), doveadm-search-query(7)


CategoryMan

None: Tools/Doveadm/Search (last edited 2021-09-22 07:08:19 by PageImporter)