Mercurial > dovecot > core-2.2

comparison doc/man/doveadm-fetch.1.in @ 11644:be2b7d2901a0 HEAD

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: added manual pages
author Pascal Volk <user@localhost.localdomain.org>
date Mon, 28 Jun 2010 13:56:39 +0000
parents
children fee02c0565e7
comparison
equal deleted inserted replaced
11643:9be162cc2c52 11644:be2b7d2901a0
1 .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
2 .TH DOVEADM\-FETCH 1 "2010-06-26" "Dovecot v2.0" "Dovecot"
3 .SH NAME
4 doveadm\-fetch \- Fetch partial/full messages or message information
5 .\"------------------------------------------------------------------------
6 .SH SYNOPSIS
7 .BR doveadm " [" \-Dv "] [" \-f
8 .IR formatter ]
9 .B fetch
10 .I fields search_query
11 .br
12 .\"-------------------------------------
13 .BR doveadm " [" \-Dv "] [" \-f
14 .IR formatter ]
15 .B fetch \-A
16 .I fields search_query
17 .br
18 .\"-------------------------------------
19 .BR doveadm " [" \-Dv "] [" \-f
20 .IR formatter ]
21 .B fetch \-u
22 .I user fields search_query
23 .\"------------------------------------------------------------------------
24 .SH DESCRIPTION
25 .B doveadm fetch
26 can be used to fetch messages\(aq contents and metadata. This can be useful
27 for scripts and for debugging. If you want to fetch messages one at a time,
28 see
29 .BR doveadm\-search (1).
30 .IP Important:
31 Please respect your users\(aq privacy.
32 .\"------------------------------------------------------------------------
33 @INCLUDE:global-options-formatter@
34 .\" --- command specific options --- "/.
35 .PP
36 This command uses by default the output formatter
37 .BR pager .
38 .PP
39 Command specific
40 .IR options :
41 .\"-------------------------------------
42 @INCLUDE:option-A@
43 .\"-------------------------------------
44 @INCLUDE:option-u-user@
45 .\"------------------------------------------------------------------------
46 .SH ARGUMENTS
47 .TP
48 .I fields
49 One or more result field names to display, if the
50 .I search_query
51 matches any messages.
52 In order to specify multiple fields, enclose them in single or double
53 quotes.
54 .br
55 Supported
56 .I fields
57 are:
58 .RS
59 .TP
60 .B body
61 .\"-----------------
62 The body of a message.
63 .TP
64 .B date.received
65 Date and time of final delivery, when the message was delivered to a
66 user\(aqs mailbox for the first time.
67 .br
68 The internal date and time of the source message, when the message was
69 copied by the IMAP COPY command.
70 .br
71 The date\-time attribute when present, otherwise the current time, when the
72 message was saved by the IMAP APPEND command.
73 .\"-----------------
74 .TP
75 .B date.saved
76 Date and time when the message was saved to mailbox.
77 .\"-----------------
78 .TP
79 .B date.sent
80 Date and time of the message\(aqs Date: header.
81 .\"-----------------
82 .TP
83 .B flags
84 A message\(aqs IMAP flags, e.g. \(rsSeen
85 .\"-----------------
86 .TP
87 .B guid
88 A message\(aqs globally unique identifier.
89 .\"-----------------
90 .TP
91 .B hdr
92 The header of the message.
93 .\"-----------------
94 .TP
95 .B imap.body
96 IMAP BODY output of the message (see RFC 3501).
97 .\"-----------------
98 .TP
99 .B imap.bodystructure
100 IMAP BODYSTRUCTURE output of the message (see RFC 3501).
101 .\"-----------------
102 .TP
103 .B imap.envelope
104 IMAP ENVELOPE output of the message (see RFC 3501).
105 .\"-----------------
106 .TP
107 .B mailbox
108 Name of the mailbox, in which the message is stored. The name is in UTF\-8.
109 .\"-----------------
110 .TP
111 .B mailbox\-guid
112 The globally unique identifier of the mailbox, in which the message is
113 located.
114 .\"-----------------
115 .TP
116 .B seq
117 A message\(aqs sequence number in a mailbox.
118 .\"-----------------
119 .TP
120 .B size.physical
121 A message\(aqs physical size.
122 .\"-----------------
123 .TP
124 .B size.virtual
125 A message\(aqs virtual size, computed with CRLF line terminators.
126 .\"-----------------
127 .TP
128 .B text
129 The entire message (header and body).
130 .\"-----------------
131 .TP
132 .B uid
133 A message\(aqs unique (IMAP) identifier in a mailbox.
134 .\"-----------------
135 .TP
136 .B user
137 A message owner\(aqs login name.
138 .\"-----------------
139 .RE
140 .\"-------------------------------------
141 .TP
142 .I search_query
143 Fetch messages matching this search query.
144 See
145 .BR doveadm\-search\-query (7)
146 for details.
147 .\"------------------------------------------------------------------------
148 .SH EXAMPLE
149 This example based on the first example from
150 .BR doveadm\-search (1).
151 We are fetching the fields
152 .BR mailbox\ and\ date.sent
153 from user bob\(aqs mailbox with the guid
154 \(dq3a94c928d66ebe4bda04000015811c6a\(dq for the messages with the
155 UIDs
156 .BR 8 ,\ 25 \ and \ 45 .
157 .PP
158 .nf
159 .B doveadm fetch \-u bob \(dqmailbox date.sent\(dq \(rs
160 .B mailbox\-guid 3a94c928d66ebe4bda04000015811c6a uid 8,25,45
161 mailbox: dovecot/pigeonhole/2.0
162 date.sent: 2010\-01\-19 01:17:41 (+0100)
163 ^L
164 mailbox: dovecot/pigeonhole/2.0
165 date.sent: 2010\-01\-28 09:38:49 (+0100)
166 ^L
167 mailbox: dovecot/pigeonhole/2.0
168 date.sent: 2010\-03\-28 18:41:14 (+0200)
169 ^L
170 .fi
171 .\"------------------------------------------------------------------------
172 @INCLUDE:reporting-bugs@
173 .\"------------------------------------------------------------------------
174 .SH SEE ALSO
175 .BR doveadm (1),
176 .BR doveadm\-search (1),
177 .BR doveadm\-search\-query (7)