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