idnits 2.17.1 draft-murchison-imap-list-myrights-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (November 22, 2016) is 2712 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) ** Obsolete normative reference: RFC 3501 (Obsoleted by RFC 9051) Summary: 1 error (**), 0 flaws (~~), 1 warning (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Independent Submission K. Murchison 3 Internet-Draft CMU 4 Intended status: Standards Track B. Gondwana 5 Expires: May 26, 2017 FastMail 6 November 22, 2016 8 IMAP4 Extension for Returning MYRIGHTS Information in Extended LIST 9 draft-murchison-imap-list-myrights-00 11 Abstract 13 This document defines an extension to the to IMAP LIST command that 14 allows the client to request the set of rights that the logged-in 15 user has been granted on mailboxes, along with other information 16 typically returned by the LIST command. 18 Status of This Memo 20 This Internet-Draft is submitted in full conformance with the 21 provisions of BCP 78 and BCP 79. 23 Internet-Drafts are working documents of the Internet Engineering 24 Task Force (IETF). Note that other groups may also distribute 25 working documents as Internet-Drafts. The list of current Internet- 26 Drafts is at http://datatracker.ietf.org/drafts/current/. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference 31 material or to cite them other than as "work in progress." 33 This Internet-Draft will expire on May 26, 2017. 35 Copyright Notice 37 Copyright (c) 2016 IETF Trust and the persons identified as the 38 document authors. All rights reserved. 40 This document is subject to BCP 78 and the IETF Trust's Legal 41 Provisions Relating to IETF Documents 42 (http://trustee.ietf.org/license-info) in effect on the date of 43 publication of this document. Please review these documents 44 carefully, as they describe your rights and restrictions with respect 45 to this document. Code Components extracted from this document must 46 include Simplified BSD License text as described in Section 4.e of 47 the Trust Legal Provisions and are provided without warranty as 48 described in the Simplified BSD License. 50 Table of Contents 52 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 53 2. Conventions Used in This Document . . . . . . . . . . . . . . 2 54 3. MYRIGHTS Return Option to LIST Command . . . . . . . . . . . 2 55 4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 3 56 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 3 57 6. Security Considerations . . . . . . . . . . . . . . . . . . . 3 58 7. Privacy Considerations . . . . . . . . . . . . . . . . . . . 4 59 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 60 8.1. Registration of IMAP capability LIST-MYRIGHTS . . . . . . 4 61 8.2. Registration of LIST-EXTENDED option MYRIGHTS . . . . . . 4 62 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 4 63 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 4 64 10.1. Normative References . . . . . . . . . . . . . . . . . . 5 65 10.2. Informative References . . . . . . . . . . . . . . . . . 5 66 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 5 68 1. Introduction 70 IMAP clients typically fetch the set of rights granted on mailboxes 71 so they can expose the allowed functionality to the logged-in user. 72 In order to do that, the client is forced to issue a LIST or LSUB 73 command to list all available mailboxes, followed by a MYRIGHTS 74 command for each mailbox found. This document defines an extension 75 to the to IMAP LIST command that allows the client to request the set 76 of rights that the logged-in user has been granted on mailboxes, 77 along with other information typically returned by the LIST command. 79 2. Conventions Used in This Document 81 In examples, "C:" indicates lines sent by a client that is connected 82 to a server. "S:" indicates lines sent by the server to the client. 84 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 85 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 86 "OPTIONAL" in this document are to be interpreted as described in 87 [RFC2119]. 89 3. MYRIGHTS Return Option to LIST Command 91 [RFC4314] defines the MYRIGHTS command which is used by an IMAP 92 client to determine the set of rights that the logged-in user has 93 been granted on a given mailbox. Frequently, a client will have to 94 look up the rights for some or all of the mailboxes returned by the 95 LIST command. Doing so in multiple MYRIGHTS commands wastes 96 bandwidth and can degrade performance if the client does not pipeline 97 the requests. This document extends the LIST command with a new 98 return option, MYRIGHTS, which allows the client to request all of 99 the desired information in a single command. For each listable 100 mailbox matching the list pattern and selection options, the server 101 MUST return an untagged LIST response followed by an untagged 102 MYRIGHTS response containing the set of rights granted to the logged- 103 in user. 105 If the server is unable to look up the set of rights for a given 106 mailbox, it MAY drop the corresponding MYRIGHTS reply. In such a 107 situation, the LIST command would still return a tagged OK reply. 109 4. Examples 111 In this example the "bar" mailbox doesn't exist, so it has no 112 MYRIGHTS reply. 114 C: A01 LIST "" % RETURN (MYRIGHTS) 115 S: * LIST () "." "INBOX" 116 S: * MYRIGHTS "INBOX" lrswipkxtecdan 117 S: * LIST () "." "foo" 118 S: * MYRIGHTS "foo" lrs 119 S: * LIST (\NonExistent) "." "bar" 120 S: A01 OK List completed. 122 In this example the LIST reply for the "foo" mailbox is returned 123 because it has matching children, but no MYRIGHTS reply is returned 124 because "foo" itself doesn't match the selection criteria. 126 C: A02 LIST (SUBSCRIBED RECURSIVEMATCH) "" % RETURN (MYRIGHTS) 127 S: * LIST (\Subscribed) "." "INBOX" 128 S: * MYRIGHTS "INBOX" lrswipkxtecdan 129 S: * LIST () "." "foo" (CHILDINFO ("SUBSCRIBED")) 130 S: A02 OK List completed. 132 5. Formal Syntax 134 The following syntax specification uses the augmented Backus-Naur 135 Form (BNF) as described in [RFC5234]. Terms not defined here are 136 taken from [RFC5258]. 138 return-option =/ "MYRIGHTS" 140 6. Security Considerations 142 This specification does not introduce any additional security 143 concerns beyond those described in [RFC5258]. 145 7. Privacy Considerations 147 This specification does not introduce any additional privacy concerns 148 beyond those described in [RFC4314]. 150 8. IANA Considerations 152 8.1. Registration of IMAP capability LIST-MYRIGHTS 154 This document defines the "LIST-MYRIGHTS" IMAP capability to be added 155 to the registry defined in Section 12 of [RFC3501]. 157 8.2. Registration of LIST-EXTENDED option MYRIGHTS 159 This section registers the "MYRIGHTS" option to be added to the 160 registry defined in Section 9 of [RFC5258]. 162 LIST-EXTENDED option name: MYRIGHTS 164 LIST-EXTENDED option type: RETURN 166 LIST-EXTENDED option description: Causes the LIST command to return 167 MYRIGHTS responses in addition to LIST responses. 169 Published specification: RFC XXXX, Section 3 171 Security considerations: RFC XXXX, Section 6 173 Intended usage: COMMON 175 Person and email address to contact for further 176 information: 177 Kenneth Murchison 179 Owner/Change controller: IESG 181 9. Acknowledgments 183 This document is based largely on [RFC5819]. The author would like 184 to thank the authors of that document for providing both inspiration 185 and some borrowed text for this document. 187 10. References 188 10.1. Normative References 190 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 191 Requirement Levels", BCP 14, RFC 2119, 192 DOI 10.17487/RFC2119, March 1997, 193 . 195 [RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 196 4rev1", RFC 3501, DOI 10.17487/RFC3501, March 2003, 197 . 199 [RFC4314] Melnikov, A., "IMAP4 Access Control List (ACL) Extension", 200 RFC 4314, DOI 10.17487/RFC4314, December 2005, 201 . 203 [RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax 204 Specifications: ABNF", STD 68, RFC 5234, 205 DOI 10.17487/RFC5234, January 2008, 206 . 208 [RFC5258] Leiba, B. and A. Melnikov, "Internet Message Access 209 Protocol version 4 - LIST Command Extensions", RFC 5258, 210 DOI 10.17487/RFC5258, June 2008, 211 . 213 10.2. Informative References 215 [RFC5819] Melnikov, A. and T. Sirainen, "IMAP4 Extension for 216 Returning STATUS Information in Extended LIST", RFC 5819, 217 DOI 10.17487/RFC5819, March 2010, 218 . 220 Authors' Addresses 222 Kenneth Murchison 223 Carnegie Mellon University 224 5000 Forbes Avenue 225 Pittsburgh, PA 15213 226 USA 228 Email: murch@andrew.cmu.edu 229 Bron Gondwana 230 FastMail Pty Ltd 231 Level 1, 91 William Street 232 Melbourne, VIC 3000 233 Australia 235 Email: brong@fastmail.fm