draft-ietf-extra-imap-list-myrights-04.txt   draft-ietf-extra-imap-list-myrights-05.txt 
EXTRA K. Murchison EXTRA K. Murchison
Internet-Draft B. Gondwana Internet-Draft B. Gondwana
Intended status: Standards Track FastMail Intended status: Standards Track FastMail
Expires: October 28, 2018 April 26, 2018 Expires: October 31, 2018 April 29, 2018
IMAP4 Extension for Returning MYRIGHTS Information in Extended LIST IMAP4 Extension for Returning MYRIGHTS Information in Extended LIST
draft-ietf-extra-imap-list-myrights-04 draft-ietf-extra-imap-list-myrights-05
Abstract Abstract
This document defines an extension to the IMAP LIST command that This document defines an extension to the Internet Message Access
allows the client to request the set of rights that the logged-in Protocol (IMAP) LIST command that allows the client to request the
user has been granted on mailboxes, along with other information set of rights that the logged-in user has been granted on mailboxes,
typically returned by the LIST command. along with other information typically returned by the LIST command.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
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 https://datatracker.ietf.org/drafts/current/. Drafts is at https://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 October 28, 2018. This Internet-Draft will expire on October 31, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2018 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
(https://trustee.ietf.org/license-info) in effect on the date of (https://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
skipping to change at page 2, line 25 skipping to change at page 2, line 25
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 . . . . . . . . . . . . . . . . . . . . . . . 5 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 5
10. Normative References . . . . . . . . . . . . . . . . . . . . 5 10. Normative References . . . . . . . . . . . . . . . . . . . . 5
Appendix A. Change History (To be removed by RFC Editor before Appendix A. Change History (To be removed by RFC Editor before
publication) . . . . . . . . . . . . . . . . . . . . 6 publication) . . . . . . . . . . . . . . . . . . . . 6
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6
1. Introduction 1. Introduction
IMAP clients typically fetch the set of rights granted on mailboxes IMAP [RFC3501] clients typically fetch the set of rights granted on
so they can expose the allowed functionality to the logged-in user. mailboxes so they can expose the allowed functionality to the logged-
In order to do that, the client is forced to issue a LIST or LSUB in user. In order to do that, the client is forced to issue a LIST
command to list all available mailboxes, followed by a MYRIGHTS or LSUB command to list all available mailboxes, followed by a
command for each mailbox found. This document defines an extension MYRIGHTS command for each mailbox found. This document defines an
to the to IMAP LIST command that is identified by the capability extension to the to IMAP LIST command that is identified by the
string "LIST-MYRIGHTS". The LIST-MYRIGHTS extension allows the capability string "LIST-MYRIGHTS". The LIST-MYRIGHTS extension
client to request the set of rights that the logged-in user has been allows the client to request the set of rights that the logged-in
granted on mailboxes, along with other information typically returned user has been granted on mailboxes, along with other information
by the LIST command. 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].
skipping to change at page 3, line 7 skipping to change at page 3, line 7
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. the requests.
This document extends the LIST command with a new return option, This document extends the LIST command with a new return option
"MYRIGHTS", which allows the client to request all of the desired [RFC5258], "MYRIGHTS", which allows the client to request all of the
information in a single command. For each listable mailbox matching desired information in a single command. For each listable mailbox
the list pattern and selection options, the server MUST return an matching the list pattern and selection options, the server MUST
untagged LIST response and SHOULD also return an untagged MYRIGHTS return an untagged LIST response and SHOULD also return an untagged
response containing the set of rights granted to the logged-in user. MYRIGHTS response containing the set of rights granted to the logged-
The ordering of the responses is significant only in that the server in user. The ordering of the responses is significant only in that
MUST NOT send a MYRIGHTS response for a given mailbox before it sends the server MUST NOT send a MYRIGHTS response for a given mailbox
the LIST response for that 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 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. mailbox, it does not send the MYRIGHTS reply for that mailbox.
Client authors ought to note that generating the MYRIGHTS responses Client authors ought to note that generating the MYRIGHTS responses
for a large number of mailboxes may be an expensive operation for the for a large number of mailboxes may be an expensive operation for the
server. Clients SHOULD use a suitable match pattern and/or selection server. Clients SHOULD use a suitable match pattern and/or selection
option to limit the set of mailboxes returned to only those whose option to limit the set of mailboxes returned to only those whose
rights in which they are interested. rights in which they are interested.
skipping to change at page 6, line 8 skipping to change at page 6, line 8
<https://www.rfc-editor.org/info/rfc5234>. <https://www.rfc-editor.org/info/rfc5234>.
[RFC5258] Leiba, B. and A. Melnikov, "Internet Message Access [RFC5258] Leiba, B. and A. Melnikov, "Internet Message Access
Protocol version 4 - LIST Command Extensions", RFC 5258, Protocol version 4 - LIST Command Extensions", RFC 5258,
DOI 10.17487/RFC5258, June 2008, DOI 10.17487/RFC5258, June 2008,
<https://www.rfc-editor.org/info/rfc5258>. <https://www.rfc-editor.org/info/rfc5258>.
Appendix A. Change History (To be removed by RFC Editor before Appendix A. Change History (To be removed by RFC Editor before
publication) publication)
Changes from draft-ietf-extra-imap-list-myrights-04:
o Added references for "IMAP" and "return option".
Changes from draft-ietf-extra-imap-list-myrights-03: Changes from draft-ietf-extra-imap-list-myrights-03:
o Fixed a typo in the Abstract. o Fixed a typo in the Abstract.
Changes from draft-ietf-extra-imap-list-myrights-02: Changes from draft-ietf-extra-imap-list-myrights-02:
o WGLC editorial changes from Barry Leiba. o WGLC editorial changes from Barry Leiba.
Changes from draft-ietf-extra-imap-list-myrights-01: Changes from draft-ietf-extra-imap-list-myrights-01:
 End of changes. 7 change blocks. 
26 lines changed or deleted 30 lines changed or added

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