]> FastMail Pty Ltd

Level 2, 114 William Street Melbourne VIC 3000 Australia murch@fastmailteam.com

FastMail Pty Ltd

Level 2, 114 William Street Melbourne VIC 3000 Australia brong@fastmailteam.com

ART EXTRA IMAP4 LIST MYRIGHTS 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 user has been granted on mailboxes, along with other information typically returned by the LIST command.

IMAP 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.

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 .

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 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 return option, "MYRIGHTS", which 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 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 mailbox, it MAY drop the corresponding MYRIGHTS reply. In such a situation, the LIST command would still return a tagged OK reply.

In this example the "bar" mailbox doesn't exist, so it has no MYRIGHTS reply.

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.

The following syntax specification uses the augmented Backus-Naur Form (BNF) as described in . Terms not defined here are taken from .

This specification does not introduce any additional security concerns beyond those described in .

This specification does not introduce any additional privacy concerns beyond those described in .

This document defines the "LIST-MYRIGHTS" IMAP capability to be added to the registry defined in Section 12 of .

This section registers the "MYRIGHTS" option to be added to the registry defined in Section 9 of . MYRIGHTS RETURN Causes the LIST command to return MYRIGHTS responses in addition to LIST responses. RFC XXXX, RFC XXXX, COMMON Kenneth Murchison <murch@andrew.cmu.edu> IESG <iesg@ietf.org>

This document is based largely on . The author would like to thank the authors of that document for providing both inspiration and some borrowed text for this document.

&rfc2119; &rfc3501; &rfc4314; &rfc5234; &rfc5258; &rfc5819;

Changes from draft-murchison-imap-list-myrights-01: Renamed document to be a work product of the EXTRA WG. Updated authors' addresses. Changes from draft-murchison-imap-list-myrights-00: Augmented Introduction with mention of "LIST-MYRIGHTS" capability string. Minor editorial changes.