Internet Engineering Task Force (IETF) K. Murchison
Request for Comments: 8440 B. Gondwana
Category: Standards Track FastMail
ISSN: 2070-1721 August 2018
Internet Engineering Task Force (IETF) K. Murchison
Request for Comments: 8440 B. Gondwana
Category: Standards Track FastMail
ISSN: 2070-1721 August 2018
IMAP4 Extension for Returning MYRIGHTS Information in Extended LIST
IMAP4扩展，用于返回扩展列表中的大量信息
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.
本文档定义了对Internet消息访问协议（IMAP）列表命令的扩展，该命令允许客户端请求已登录用户在邮箱上获得的权限集，以及通常由LIST命令返回的其他信息。
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 Section 2 of RFC 7841.
本文件是互联网工程任务组（IETF）的产品。它代表了IETF社区的共识。它已经接受了公众审查，并已被互联网工程指导小组（IESG）批准出版。有关互联网标准的更多信息，请参见RFC 7841第2节。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc8440.
有关本文件当前状态、任何勘误表以及如何提供反馈的信息，请访问https://www.rfc-editor.org/info/rfc8440.
Copyright Notice
版权公告
Copyright (c) 2018 IETF Trust and the persons identified as the document authors. All rights reserved.
版权所有（c）2018 IETF信托基金和确定为文件作者的人员。版权所有。
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) 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.
本文件受BCP 78和IETF信托有关IETF文件的法律规定的约束(https://trustee.ietf.org/license-info)自本文件出版之日起生效。请仔细阅读这些文件，因为它们描述了您对本文件的权利和限制。从本文件中提取的代码组件必须包括信托法律条款第4.e节中所述的简化BSD许可证文本，并提供简化BSD许可证中所述的无担保。
Table of Contents
目录
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Conventions Used in This Document . . . . . . . . . . . . . . 2
3. MYRIGHTS Return Option to LIST Command . . . . . . . . . . . 2
4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 3
5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 4
6. Security Considerations . . . . . . . . . . . . . . . . . . . 4
7. Privacy Considerations . . . . . . . . . . . . . . . . . . . 4
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4
8.1. Registration of IMAP Capability LIST-MYRIGHTS . . . . . . 4
8.2. Registration of LIST-EXTENDED Option MYRIGHTS . . . . . . 4
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 5
9.1. Normative References . . . . . . . . . . . . . . . . . . 5
9.2. Informative References . . . . . . . . . . . . . . . . . 6
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 6
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Conventions Used in This Document . . . . . . . . . . . . . . 2
3. MYRIGHTS Return Option to LIST Command . . . . . . . . . . . 2
4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 3
5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 4
6. Security Considerations . . . . . . . . . . . . . . . . . . . 4
7. Privacy Considerations . . . . . . . . . . . . . . . . . . . 4
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4
8.1. Registration of IMAP Capability LIST-MYRIGHTS . . . . . . 4
8.2. Registration of LIST-EXTENDED Option MYRIGHTS . . . . . . 4
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 5
9.1. Normative References . . . . . . . . . . . . . . . . . . 5
9.2. Informative References . . . . . . . . . . . . . . . . . 6
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 6
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6
IMAP [RFC3501] 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.
IMAP[RFC3501]客户端通常获取邮箱上授予的权限集，以便向登录用户公开允许的功能。为此，客户端必须发出LIST或LSUB命令来列出所有可用邮箱，然后对找到的每个邮箱执行MYRIGHTS命令。本文档定义了to IMAP LIST命令的扩展，该命令由功能字符串“LIST-MIRRIGhts”标识。LIST-MYRIGHTS扩展允许客户端请求登录用户在邮箱上获得的权限集，以及通常由LIST命令返回的其他信息。
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.
在示例中，“C:”表示连接到服务器的客户端发送的线路。“S:”表示服务器发送到客户端的行。
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 BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
本文件中的关键词“必须”、“不得”、“必需”、“应”、“不应”、“建议”、“不建议”、“可”和“可选”在所有大写字母出现时（如图所示）应按照BCP 14[RFC2119][RFC8174]所述进行解释。
[RFC4314] 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
[RFC4314]定义MYRIGHTS命令，IMAP客户端使用该命令确定登录用户在给定邮箱上被授予的权限集。通常，客户端必须查找服务器返回的部分或全部邮箱的权限
LIST command. Doing so in multiple MYRIGHTS commands wastes bandwidth and can degrade performance if the client does not pipeline the requests.
LIST命令。在多个命令中这样做会浪费带宽，并且如果客户端不通过管道传输请求，会降低性能。
This document extends the LIST command with a new "MYRIGHTS" return option [RFC5258] 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.
本文档使用新的“MYRIGHTS”返回选项[RFC5258]扩展了LIST命令，该选项允许客户端在单个命令中请求所有所需信息。对于与列表模式和选择选项匹配的每个可列出邮箱，服务器必须返回一个未标记的列表响应，并且还应返回一个未标记的响应，其中包含授予登录用户的一组权限。响应的顺序非常重要，因为服务器在发送给定邮箱的列表响应之前，不能发送该邮箱的列表响应。
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.
客户机作者应该注意，为大量邮箱生成MYRIGHTS响应对于服务器来说可能是一项昂贵的操作。客户端应使用合适的匹配模式和/或选择选项，将返回的邮箱集限制为仅对其权限感兴趣的邮箱。
In this example, the "bar" mailbox doesn't exist, so it has no MYRIGHTS reply.
在本例中，“bar”邮箱不存在，因此没有回复。
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.
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.
在本例中，返回“foo”邮箱的列表回复，因为它有匹配的子项，但不返回任何回复，因为“foo”本身与选择条件不匹配。
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.
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.
The following syntax specification uses the augmented Backus-Naur Form (BNF) as described in [RFC5234]. Terms not defined here are taken from [RFC5258].
以下语法规范使用[RFC5234]中所述的增广巴科斯诺尔形式（BNF）。此处未定义的术语取自[RFC5258]。
return-option =/ "MYRIGHTS"
返回选项=/“MYRIGHTS”
In addition to the security considerations described in [RFC4314], 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.
除了[RFC4314]中描述的安全注意事项外，此扩展还可以通过请求大量邮箱的信息，使客户端更容易过载服务器。但是，正如介绍中所指出的，现有客户机已经尝试通过为他们感兴趣的每个邮箱生成大量MYRIGHTS命令来实现这一点。在对大的邮箱列表执行MYRIGHTS信息检索时，服务器实现需要确保它仍然可以服务于其他IMAP连接，并在必要时让其他连接执行。
This specification does not introduce any additional privacy concerns beyond those described in [RFC4314].
除了[RFC4314]中描述的隐私问题外，本规范不引入任何其他隐私问题。
This document defines the "LIST-MYRIGHTS" IMAP capability that has been added to the "IMAP Capabilities" registry [CAPABILITIES].
本文档定义了已添加到“IMAP功能”注册表[功能]中的“列表功能”IMAP功能。
This section registers the "MYRIGHTS" option that has been added to the "LIST-EXTENDED options" registry [EXTENDED].
本节注册已添加到“列表扩展选项”注册表[EXTENDED]中的“MYRIGHTS”选项。
LIST-EXTENDED option name: MYRIGHTS
列表扩展选项名称：MYRIGHTS
LIST-EXTENDED option type: RETURN
列表扩展选项类型：返回
LIST-EXTENDED option description: Causes the LIST command to return MYRIGHTS responses in addition to LIST responses.
LIST-EXTENDED选项说明：使LIST命令除了返回LIST响应外，还返回无数响应。
Published specification: RFC 8440, Section 3
出版规范：RFC 8440，第3节
Security considerations: RFC 8440, Section 6
安全注意事项：RFC 8440，第6节
Intended usage: COMMON
预期用途：普通
Person and email address to contact for further information:
Kenneth Murchison <murch@fastmailteam.com>
Person and email address to contact for further information:
Kenneth Murchison <murch@fastmailteam.com>
Owner/Change controller: IESG <iesg@ietf.org>
Owner/Change controller: IESG <iesg@ietf.org>
[CAPABILITIES] IANA, "Internet Message Access Protocol (IMAP) Capabilities Registry", <https://www.iana.org/assignments/ imap-capabilities/imap-capabilities>.
[功能]IANA，“互联网消息访问协议（IMAP）功能注册表”<https://www.iana.org/assignments/ imap功能/imap功能>。
[EXTENDED] IANA, "Internet Message Access Protocol (IMAP) LIST EXTENDED Registry", <https://www.iana.org/assignments/imap-list-extended>.
[扩展]IANA，“互联网消息访问协议（IMAP）列表扩展注册表”<https://www.iana.org/assignments/imap-list-extended>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/info/rfc2119>.
[RFC2119]Bradner，S.，“RFC中用于表示需求水平的关键词”，BCP 14，RFC 2119，DOI 10.17487/RFC2119，1997年3月<https://www.rfc-editor.org/info/rfc2119>.
[RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 3501, DOI 10.17487/RFC3501, March 2003, <https://www.rfc-editor.org/info/rfc3501>.
[RFC3501]Crispin，M.，“互联网消息访问协议-版本4rev1”，RFC 3501，DOI 10.17487/RFC3501，2003年3月<https://www.rfc-editor.org/info/rfc3501>.
[RFC4314] Melnikov, A., "IMAP4 Access Control List (ACL) Extension", RFC 4314, DOI 10.17487/RFC4314, December 2005, <https://www.rfc-editor.org/info/rfc4314>.
[RFC4314]Melnikov，A.，“IMAP4访问控制列表（ACL）扩展”，RFC 4314，DOI 10.17487/RFC4314，2005年12月<https://www.rfc-editor.org/info/rfc4314>.
[RFC5234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, DOI 10.17487/RFC5234, January 2008, <https://www.rfc-editor.org/info/rfc5234>.
[RFC5234]Crocker，D.，Ed.和P.Overell，“语法规范的扩充BNF:ABNF”，STD 68，RFC 5234，DOI 10.17487/RFC5234，2008年1月<https://www.rfc-editor.org/info/rfc5234>.
[RFC5258] Leiba, B. and A. Melnikov, "Internet Message Access Protocol version 4 - LIST Command Extensions", RFC 5258, DOI 10.17487/RFC5258, June 2008, <https://www.rfc-editor.org/info/rfc5258>.
[RFC5258]Leiba，B.和A.Melnikov，“互联网消息访问协议第4版-列表命令扩展”，RFC 5258，DOI 10.17487/RFC5258，2008年6月<https://www.rfc-editor.org/info/rfc5258>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8174]Leiba，B.，“RFC 2119关键词中大写与小写的歧义”，BCP 14，RFC 8174，DOI 10.17487/RFC8174，2017年5月<https://www.rfc-editor.org/info/rfc8174>.
[RFC5819] Melnikov, A. and T. Sirainen, "IMAP4 Extension for Returning STATUS Information in Extended LIST", RFC 5819, DOI 10.17487/RFC5819, March 2010, <https://www.rfc-editor.org/info/rfc5819>.
[RFC5819]Melnikov，A.和T.Sirainen，“扩展列表中返回状态信息的IMAP4扩展”，RFC 5819，DOI 10.17487/RFC5819，2010年3月<https://www.rfc-editor.org/info/rfc5819>.
Acknowledgments
致谢
This document is based largely on [RFC5819]. 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.
本文件主要基于[RFC5819]。作者要感谢该文件的作者为本文件提供了灵感和一些借来的文本。作者还要感谢Barry Leiba为编写本规范贡献了自己的想法和支持。
Authors' Addresses
作者地址
Kenneth Murchison FastMail Pty Ltd. Level 2, 114 William Street Melbourne, VIC 3000 Australia
澳大利亚维多利亚州墨尔本威廉街114号Kenneth Murchison FastMail私人有限公司2楼
Email: murch@fastmailteam.com
Email: murch@fastmailteam.com
Bron Gondwana FastMail Pty Ltd. Level 2, 114 William Street Melbourne, VIC 3000 Australia
澳大利亚维多利亚州墨尔本威廉街114号Bron Gondwana FastMail私人有限公司2楼
Email: brong@fastmailteam.com
Email: brong@fastmailteam.com