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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
<pre>Internet Engineering Task Force (IETF) K. Murchison
Request for Comments: 8440 B. Gondwana
Category: Standards Track FastMail
ISSN: 2070-1721 August 2018
<span class="h1">IMAP4 Extension for Returning MYRIGHTS Information in Extended LIST</span>
Abstract
This document defines an extension to the Internet Message Access
Protocol (IMAP) LIST command that allows the client to request the
set of rights that the logged-in user has been granted on mailboxes,
along with other information typically returned by the LIST command.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc7841#section-2">Section 2 of RFC 7841</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="https://www.rfc-editor.org/info/rfc8440">https://www.rfc-editor.org/info/rfc8440</a>.
Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
<span class="grey">Murchison & Gondwana Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc8440">RFC 8440</a> IMAP LIST-MYRIGHTS August 2018</span>
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-2">2</a>. Conventions Used in This Document . . . . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-3">3</a>. MYRIGHTS Return Option to LIST Command . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-4">4</a>. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-5">5</a>. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-6">6</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-7">7</a>. Privacy Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-8">8</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-8.1">8.1</a>. Registration of IMAP Capability LIST-MYRIGHTS . . . . . . <a href="#page-4">4</a>
<a href="#section-8.2">8.2</a>. Registration of LIST-EXTENDED Option MYRIGHTS . . . . . . <a href="#page-4">4</a>
<a href="#section-9">9</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-9.1">9.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a>
<a href="#section-9.2">9.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
IMAP [<a href="./rfc3501" title=""INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1"">RFC3501</a>] clients typically fetch the set of rights granted on
mailboxes so they can expose the allowed functionality to the logged-
in user. In order to do that, the client is forced to issue a LIST
or LSUB command to list all available mailboxes, followed by a
MYRIGHTS command for each mailbox found. This document defines an
extension to the to IMAP LIST command that is identified by the
capability string "LIST-MYRIGHTS". The LIST-MYRIGHTS extension
allows the client to request the set of rights that the logged-in
user has been granted on mailboxes, along with other information
typically returned by the LIST command.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Conventions Used in This Document</span>
In examples, "C:" indicates lines sent by a client that is connected
to a server. "S:" indicates lines sent by the server to the client.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
<a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>] [<a href="./rfc8174" title=""Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"">RFC8174</a>] when, and only when, they appear in all
capitals, as shown here.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. MYRIGHTS Return Option to LIST Command</span>
[<a id="ref-RFC4314">RFC4314</a>] defines the MYRIGHTS command, which is used by an IMAP
client to determine the set of rights that the logged-in user has
been granted on a given mailbox. Frequently, a client will have to
look up the rights for some or all of the mailboxes returned by the
<span class="grey">Murchison & Gondwana Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc8440">RFC 8440</a> IMAP LIST-MYRIGHTS August 2018</span>
LIST command. Doing so in multiple MYRIGHTS commands wastes
bandwidth and can degrade performance if the client does not pipeline
the requests.
This document extends the LIST command with a new "MYRIGHTS" return
option [<a href="./rfc5258" title=""Internet Message Access Protocol version 4 - LIST Command Extensions"">RFC5258</a>] that allows the client to request all of the desired
information in a single command. For each listable mailbox matching
the list pattern and selection options, the server MUST return an
untagged LIST response and SHOULD also return an untagged MYRIGHTS
response containing the set of rights granted to the logged-in user.
The ordering of the responses is significant only in that the server
MUST NOT send a MYRIGHTS response for a given mailbox before it sends
the LIST response for that mailbox.
If the server is unable to look up the set of rights for a given
mailbox, it does not send the MYRIGHTS reply for that mailbox.
Client authors ought to note that generating the MYRIGHTS responses
for a large number of mailboxes may be an expensive operation for the
server. Clients SHOULD use a suitable match pattern and/or selection
option to limit the set of mailboxes returned to only those in whose
rights they are interested.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Examples</span>
In this example, the "bar" mailbox doesn't exist, so it has no
MYRIGHTS reply.
C: A01 LIST "" % RETURN (MYRIGHTS)
S: * LIST () "." "INBOX"
S: * MYRIGHTS "INBOX" lrswipkxtecda
S: * LIST () "." "foo"
S: * MYRIGHTS "foo" lrs
S: * LIST (\NonExistent) "." "bar"
S: A01 OK List completed.
In this example, the LIST reply for the "foo" mailbox is returned
because it has matching children, but no MYRIGHTS reply is returned,
because "foo" itself doesn't match the selection criteria.
C: A02 LIST (SUBSCRIBED RECURSIVEMATCH) "" % RETURN (MYRIGHTS)
S: * LIST (\Subscribed) "." "INBOX"
S: * MYRIGHTS "INBOX" lrswipkxtecda
S: * LIST () "." "foo" (CHILDINFO ("SUBSCRIBED"))
S: A02 OK List completed.
<span class="grey">Murchison & Gondwana Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc8440">RFC 8440</a> IMAP LIST-MYRIGHTS August 2018</span>
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Formal Syntax</span>
The following syntax specification uses the augmented Backus-Naur
Form (BNF) as described in [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>]. Terms not defined here are
taken from [<a href="./rfc5258" title=""Internet Message Access Protocol version 4 - LIST Command Extensions"">RFC5258</a>].
return-option =/ "MYRIGHTS"
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Security Considerations</span>
In addition to the security considerations described in [<a href="./rfc4314" title=""IMAP4 Access Control List (ACL) Extension"">RFC4314</a>],
this extension makes it a bit easier for clients to overload the
server by requesting MYRIGHTS information for a large number of
mailboxes. However, as noted in the introduction, existing clients
already try to do that by generating a large number of MYRIGHTS
commands for each mailbox in which they are interested. While
performing MYRIGHTS information retrieval for big lists of mailboxes,
a server implementation needs to make sure that it can still serve
other IMAP connections and yield execution to other connections, when
necessary.
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Privacy Considerations</span>
This specification does not introduce any additional privacy concerns
beyond those described in [<a href="./rfc4314" title=""IMAP4 Access Control List (ACL) Extension"">RFC4314</a>].
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. IANA Considerations</span>
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Registration of IMAP Capability LIST-MYRIGHTS</span>
This document defines the "LIST-MYRIGHTS" IMAP capability that has
been added to the "IMAP Capabilities" registry [<a href="#ref-CAPABILITIES">CAPABILITIES</a>].
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Registration of LIST-EXTENDED Option MYRIGHTS</span>
This section registers the "MYRIGHTS" option that has been added to
the "LIST-EXTENDED options" registry [<a href="#ref-EXTENDED">EXTENDED</a>].
LIST-EXTENDED option name: MYRIGHTS
LIST-EXTENDED option type: RETURN
LIST-EXTENDED option description: Causes the LIST command to return
MYRIGHTS responses in addition to LIST responses.
Published specification: <a href="./rfc8440#section-3">RFC 8440, Section 3</a>
Security considerations: <a href="./rfc8440#section-6">RFC 8440, Section 6</a>
<span class="grey">Murchison & Gondwana Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc8440">RFC 8440</a> IMAP LIST-MYRIGHTS August 2018</span>
Intended usage: COMMON
Person and email address to contact for further information:
Kenneth Murchison <murch@fastmailteam.com>
Owner/Change controller: IESG <iesg@ietf.org>
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. References</span>
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Normative References</span>
[<a id="ref-CAPABILITIES">CAPABILITIES</a>]
IANA, "Internet Message Access Protocol (IMAP)
Capabilities Registry", <<a href="https://www.iana.org/assignments/imap-capabilities/imap-capabilities">https://www.iana.org/assignments/</a>
<a href="https://www.iana.org/assignments/imap-capabilities/imap-capabilities">imap-capabilities/imap-capabilities</a>>.
[<a id="ref-EXTENDED">EXTENDED</a>]
IANA, "Internet Message Access Protocol (IMAP) LIST
EXTENDED Registry",
<<a href="https://www.iana.org/assignments/imap-list-extended">https://www.iana.org/assignments/imap-list-extended</a>>.
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
DOI 10.17487/RFC2119, March 1997,
<<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC3501">RFC3501</a>] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION
4rev1", <a href="./rfc3501">RFC 3501</a>, DOI 10.17487/RFC3501, March 2003,
<<a href="https://www.rfc-editor.org/info/rfc3501">https://www.rfc-editor.org/info/rfc3501</a>>.
[<a id="ref-RFC4314">RFC4314</a>] Melnikov, A., "IMAP4 Access Control List (ACL) Extension",
<a href="./rfc4314">RFC 4314</a>, DOI 10.17487/RFC4314, December 2005,
<<a href="https://www.rfc-editor.org/info/rfc4314">https://www.rfc-editor.org/info/rfc4314</a>>.
[<a id="ref-RFC5234">RFC5234</a>] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, <a href="./rfc5234">RFC 5234</a>,
DOI 10.17487/RFC5234, January 2008,
<<a href="https://www.rfc-editor.org/info/rfc5234">https://www.rfc-editor.org/info/rfc5234</a>>.
[<a id="ref-RFC5258">RFC5258</a>] Leiba, B. and A. Melnikov, "Internet Message Access
Protocol version 4 - LIST Command Extensions", <a href="./rfc5258">RFC 5258</a>,
DOI 10.17487/RFC5258, June 2008,
<<a href="https://www.rfc-editor.org/info/rfc5258">https://www.rfc-editor.org/info/rfc5258</a>>.
[<a id="ref-RFC8174">RFC8174</a>] Leiba, B., "Ambiguity of Uppercase vs Lowercase in <a href="./rfc2119">RFC</a>
<a href="./rfc2119">2119</a> Key Words", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc8174">RFC 8174</a>, DOI 10.17487/RFC8174,
May 2017, <<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>>.
<span class="grey">Murchison & Gondwana Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc8440">RFC 8440</a> IMAP LIST-MYRIGHTS August 2018</span>
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Informative References</span>
[<a id="ref-RFC5819">RFC5819</a>] Melnikov, A. and T. Sirainen, "IMAP4 Extension for
Returning STATUS Information in Extended LIST", <a href="./rfc5819">RFC 5819</a>,
DOI 10.17487/RFC5819, March 2010,
<<a href="https://www.rfc-editor.org/info/rfc5819">https://www.rfc-editor.org/info/rfc5819</a>>.
Acknowledgments
This document is based largely on [<a href="./rfc5819" title=""IMAP4 Extension for Returning STATUS Information in Extended LIST"">RFC5819</a>]. The authors would like
to thank the authors of that document for providing both inspiration
and some borrowed text for this document. The authors would also
like to thank Barry Leiba for contributing his ideas and support for
writing this specification.
Authors' Addresses
Kenneth Murchison
FastMail Pty Ltd.
Level 2, 114 William Street
Melbourne, VIC 3000
Australia
Email: murch@fastmailteam.com
Bron Gondwana
FastMail Pty Ltd.
Level 2, 114 William Street
Melbourne, VIC 3000
Australia
Email: brong@fastmailteam.com
Murchison & Gondwana Standards Track [Page 6]
</pre>
|
