< draft-murchison-imap-list-myrights-00.txt   draft-murchison-imap-list-myrights-01.txt >
Independent Submission K. Murchison Independent Submission K. Murchison
Internet-Draft CMU Internet-Draft CMU
Intended status: Standards Track B. Gondwana Intended status: Standards Track B. Gondwana
Expires: May 26, 2017 FastMail Expires: November 22, 2017 FastMail
November 22, 2016 May 21, 2017
IMAP4 Extension for Returning MYRIGHTS Information in Extended LIST IMAP4 Extension for Returning MYRIGHTS Information in Extended LIST
draft-murchison-imap-list-myrights-00 draft-murchison-imap-list-myrights-01
Abstract Abstract
This document defines an extension to the to IMAP LIST command that This document defines an extension to the to IMAP LIST command that
allows the client to request the set of rights that the logged-in allows the client to request the set of rights that the logged-in
user has been granted on mailboxes, along with other information user has been granted on mailboxes, along with other information
typically returned by the LIST command. typically returned by the LIST command.
Status of This Memo Status of This Memo
skipping to change at page 1, line 34 skipping to change at page 1, line 34
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 26, 2017. This Internet-Draft will expire on November 22, 2017.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Conventions Used in This Document . . . . . . . . . . . . . . 2 2. Conventions Used in This Document . . . . . . . . . . . . . . 2
3. MYRIGHTS Return Option to LIST Command . . . . . . . . . . . 2 3. MYRIGHTS Return Option to LIST Command . . . . . . . . . . . 2
4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 3 4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 3
5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 3 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 3
6. Security Considerations . . . . . . . . . . . . . . . . . . . 3 6. Security Considerations . . . . . . . . . . . . . . . . . . . 4
7. Privacy Considerations . . . . . . . . . . . . . . . . . . . 4 7. Privacy Considerations . . . . . . . . . . . . . . . . . . . 4
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4
8.1. Registration of IMAP capability LIST-MYRIGHTS . . . . . . 4 8.1. Registration of IMAP capability LIST-MYRIGHTS . . . . . . 4
8.2. Registration of LIST-EXTENDED option MYRIGHTS . . . . . . 4 8.2. Registration of LIST-EXTENDED option MYRIGHTS . . . . . . 4
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 4 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 4
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 4 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 5
10.1. Normative References . . . . . . . . . . . . . . . . . . 5 10.1. Normative References . . . . . . . . . . . . . . . . . . 5
10.2. Informative References . . . . . . . . . . . . . . . . . 5 10.2. Informative References . . . . . . . . . . . . . . . . . 5
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 5 Appendix A. Change History (To be removed by RFC Editor before
publication) . . . . . . . . . . . . . . . . . . . . 5
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6
1. Introduction 1. Introduction
IMAP clients typically fetch the set of rights granted on mailboxes IMAP clients typically fetch the set of rights granted on mailboxes
so they can expose the allowed functionality to the logged-in user. 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 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 to list all available mailboxes, followed by a MYRIGHTS
command for each mailbox found. This document defines an extension command for each mailbox found. This document defines an extension
to the to IMAP LIST command that allows the client to request the set to the to IMAP LIST command that is identified by the capability
of rights that the logged-in user has been granted on mailboxes, string "LIST-MYRIGHTS". The LIST-MYRIGHTS extension allows the
along with other information typically returned by the LIST command. 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.
2. Conventions Used in This Document 2. Conventions Used in This Document
In examples, "C:" indicates lines sent by a client that is connected 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. to a server. "S:" indicates lines sent by the server to the client.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in "OPTIONAL" in this document are to be interpreted as described in
[RFC2119]. [RFC2119].
3. MYRIGHTS Return Option to LIST Command 3. MYRIGHTS Return Option to LIST Command
[RFC4314] defines the MYRIGHTS command which is used by an IMAP [RFC4314] defines the MYRIGHTS command which is used by an IMAP
client to determine the set of rights that the logged-in user has 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 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 look up the rights for some or all of the mailboxes returned by the
LIST command. Doing so in multiple MYRIGHTS commands wastes LIST command. Doing so in multiple MYRIGHTS commands wastes
bandwidth and can degrade performance if the client does not pipeline bandwidth and can degrade performance if the client does not pipeline
the requests. This document extends the LIST command with a new the requests.
return option, MYRIGHTS, which allows the client to request all of
the desired information in a single command. For each listable This document extends the LIST command with a new return option,
mailbox matching the list pattern and selection options, the server "MYRIGHTS", which allows the client to request all of the desired
MUST return an untagged LIST response followed by an untagged information in a single command. For each listable mailbox matching
MYRIGHTS response containing the set of rights granted to the logged- the list pattern and selection options, the server MUST return an
in user. untagged LIST response followed by an untagged MYRIGHTS response
containing the set of rights granted to the logged-in user.
If the server is unable to look up the set of rights for a given If the server is unable to look up the set of rights for a given
mailbox, it MAY drop the corresponding MYRIGHTS reply. In such a mailbox, it MAY drop the corresponding MYRIGHTS reply. In such a
situation, the LIST command would still return a tagged OK reply. situation, the LIST command would still return a tagged OK reply.
4. Examples 4. Examples
In this example the "bar" mailbox doesn't exist, so it has no In this example the "bar" mailbox doesn't exist, so it has no
MYRIGHTS reply. MYRIGHTS reply.
skipping to change at page 5, line 36 skipping to change at page 5, line 39
DOI 10.17487/RFC5258, June 2008, DOI 10.17487/RFC5258, June 2008,
<http://www.rfc-editor.org/info/rfc5258>. <http://www.rfc-editor.org/info/rfc5258>.
10.2. Informative References 10.2. Informative References
[RFC5819] Melnikov, A. and T. Sirainen, "IMAP4 Extension for [RFC5819] Melnikov, A. and T. Sirainen, "IMAP4 Extension for
Returning STATUS Information in Extended LIST", RFC 5819, Returning STATUS Information in Extended LIST", RFC 5819,
DOI 10.17487/RFC5819, March 2010, DOI 10.17487/RFC5819, March 2010,
<http://www.rfc-editor.org/info/rfc5819>. <http://www.rfc-editor.org/info/rfc5819>.
Appendix A. Change History (To be removed by RFC Editor before
publication)
Changes in draft-murchison-imap-list-myrights-01:
o Augmented Introduction with mention of "LIST-MYRIGHTS" capability
string.
o Minor editorial changes.
Authors' Addresses Authors' Addresses
Kenneth Murchison Kenneth Murchison
Carnegie Mellon University Carnegie Mellon University
5000 Forbes Avenue 5000 Forbes Avenue
Pittsburgh, PA 15213 Pittsburgh, PA 15213
USA USA
Email: murch@andrew.cmu.edu Email: murch@andrew.cmu.edu
Bron Gondwana Bron Gondwana
FastMail Pty Ltd FastMail Pty Ltd
Level 1, 91 William Street Level 1, 91 William Street
Melbourne, VIC 3000 Melbourne, VIC 3000
Australia Australia
Email: brong@fastmail.fm Email: brong@fastmail.fm
 End of changes. 12 change blocks. 
19 lines changed or deleted 35 lines changed or added

This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/