Internet Engineering Task Force (IETF) R. Sparks
Request for Comments: 6778 Tekelec
Category: Informational October 2012
ISSN: 2070-1721
Internet Engineering Task Force (IETF) R. Sparks
Request for Comments: 6778 Tekelec
Category: Informational October 2012
ISSN: 2070-1721
Requirements for Archiving IETF Email Lists and for Providing Web-Based Browsing and Searching
存档IETF电子邮件列表和提供基于Web的浏览和搜索的要求
Abstract
摘要
The IETF makes heavy use of email lists to conduct its work. Participants frequently need to search and browse the archives of these lists and have asked for improved search capabilities. The current archive mechanism could also be made more efficient. This memo captures the requirements for improved email list archiving and searching systems.
IETF大量使用电子邮件列表来开展工作。参与者经常需要搜索和浏览这些列表的档案，并要求改进搜索功能。目前的存档机制也可以提高效率。本备忘录阐述了改进电子邮件列表存档和搜索系统的要求。
Status of This Memo
关于下段备忘
This document is not an Internet Standards Track specification; it is published for informational purposes.
本文件不是互联网标准跟踪规范；它是为了提供信息而发布的。
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). Not all documents approved by the IESG are a candidate for any level of Internet Standard; see Section 2 of RFC 5741.
本文件是互联网工程任务组（IETF）的产品。它代表了IETF社区的共识。它已经接受了公众审查，并已被互联网工程指导小组（IESG）批准出版。并非IESG批准的所有文件都适用于任何级别的互联网标准；见RFC 5741第2节。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc6778.
有关本文件当前状态、任何勘误表以及如何提供反馈的信息，请访问http://www.rfc-editor.org/info/rfc6778.
Copyright Notice
版权公告
Copyright (c) 2012 IETF Trust and the persons identified as the document authors. All rights reserved.
版权所有（c）2012 IETF信托基金和确定为文件作者的人员。版权所有。
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://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文件的法律规定的约束(http://trustee.ietf.org/license-info)自本文件出版之日起生效。请仔细阅读这些文件，因为它们描述了您对本文件的权利和限制。从本文件中提取的代码组件必须包括信托法律条款第4.e节中所述的简化BSD许可证文本，并提供简化BSD许可证中所述的无担保。
Table of Contents
目录
1. Introduction ....................................................2
2. List Search and Archive Requirements ............................3
2.1. Search and Browsing ........................................3
2.2. Archiving Active Lists .....................................5
2.3. Importing Messages from Other Archives .....................5
2.4. Exporting Messages from the Archives .......................5
2.5. Redundancy .................................................6
2.6. Archive Administration .....................................6
2.7. Transition Requirements ....................................7
3. Internationalized Address Considerations ........................7
4. IMAP Access .....................................................7
5. Security Considerations .........................................7
6. Acknowledgements ................................................7
7. Informative References ..........................................8
1. Introduction ....................................................2
2. List Search and Archive Requirements ............................3
2.1. Search and Browsing ........................................3
2.2. Archiving Active Lists .....................................5
2.3. Importing Messages from Other Archives .....................5
2.4. Exporting Messages from the Archives .......................5
2.5. Redundancy .................................................6
2.6. Archive Administration .....................................6
2.7. Transition Requirements ....................................7
3. Internationalized Address Considerations ........................7
4. IMAP Access .....................................................7
5. Security Considerations .........................................7
6. Acknowledgements ................................................7
7. Informative References ..........................................8
The IETF makes heavy use of email lists to conduct its work. Participants frequently need to search the archives of these lists and have asked for improved search capabilities, particularly when the search needs to cover a large period of time or cross several lists. For instance, document editors, shepherds, working group chairs, and area directors may need to review all discussion of a particular draft. That discussion may be spread across the working group list, one or more directorate lists, and the IETF general list. Occasionally, work impacts multiple groups, possibly in different areas, and the search must cover additional working group lists.
IETF大量使用电子邮件列表来开展工作。参与者经常需要搜索这些名单的档案，并要求改进搜索能力，特别是当搜索需要覆盖很长一段时间或跨越多个名单时。例如，文件编辑、牧羊人、工作组主席和区域主任可能需要审查对特定草案的所有讨论。该讨论可能分布在工作组名单、一个或多个董事会名单和IETF总名单中。有时，工作会影响多个组，可能在不同的区域，搜索必须包括其他工作组列表。
The current tools for performing these searches require several manually coordinated steps, which are error prone. Without a local copy of the archive (which may not be complete), searching most working group lists requires brute force effort, aided possibly by web search engines.
当前用于执行这些搜索的工具需要几个手动协调的步骤，这些步骤容易出错。如果没有存档的本地副本（可能不完整），搜索大多数工作组列表需要蛮力，可能需要网络搜索引擎的帮助。
More advanced search capabilities have been constructed for a limited subset of the available lists and are exposed in the "Email Archives Quick Search" section of the main IETF website. While these tools are of great assistance, there is still significant need for improvement.
为有限的可用列表子集构建了更高级的搜索功能，并在IETF主网站的“电子邮件档案快速搜索”部分公开。虽然这些工具很有帮助，但仍有很大的改进需要。
The current archive mechanism could also be made more efficient. The current practices involve duplicate stores (for the web and ftp interfaces), which impact storage and replication and are subject to inconsistency.
目前的存档机制也可以提高效率。当前的做法涉及重复存储（用于web和ftp接口），这会影响存储和复制，并且会导致不一致。
This memo captures the requirements for improved email list archiving and searching systems.
本备忘录阐述了改进电子邮件列表存档和搜索系统的要求。
o The system must provide a web interface for searching and browsing archived messages.
o 系统必须提供用于搜索和浏览存档邮件的web界面。
o The system must allow browsing the entire archive of a given list by thread or by date.
o 系统必须允许按线程或日期浏览给定列表的整个存档。
o The system must allow browsing the results of a search by thread or by date.
o 系统必须允许按线程或日期浏览搜索结果。
Both threading based on Message-Id/References/In-Reply-To and threading based on same subject line (modulo short prefixes like re: and fwd:) should be taken into account.
应考虑基于消息Id/References/In Reply To的线程和基于相同主题行的线程（模短前缀，如re:和fwd:）。
o The system must allow searching across any subset of the archived lists (one list, a selection of lists, or all lists).
o 系统必须允许搜索存档列表的任何子集（一个列表、一组列表或所有列表）。
o The system must allow searching of any combination (using AND, OR, and NOT operators) of the following attributes. Richer search capabilities are highly desirable.
o 系统必须允许搜索以下属性的任意组合（使用AND、OR和NOT运算符）。更丰富的搜索功能是非常可取的。
- string occurring in sender name or email address
- 发件人名称或电子邮件地址中出现的字符串
- date range
- 日期范围
- string occurring in Subject
- 主语中出现的字符串
- string occurring in message body
- 消息体中出现的字符串
- string occurring in message header (in particular, exact match of Message-Id)
- 消息头中出现的字符串（特别是消息Id的精确匹配）
For instance, it would be nice to search the entire archive
for instances of a message with a given Message-ID with a
URL like <http://datatracker.ietf.org/mlarchive/
msg?id=4EA6E023.6010603@example.com>
For instance, it would be nice to search the entire archive
for instances of a message with a given Message-ID with a
URL like <http://datatracker.ietf.org/mlarchive/
msg?id=4EA6E023.6010603@example.com>
o Individual messages must be representable by a long-term stable URI that can be shared between users. That is, the URI must be suitable for reference in an email message.
o 单个消息必须由用户之间可以共享的长期稳定URI表示。也就是说，URI必须适合在电子邮件消息中引用。
- It would be preferable for that URI to appear in an Archived-At header field in the message [RFC5064].
- 该URI最好出现在消息[RFC5064]中的存档地址标头字段中。
o Searches should be representable by a URI that can be shared between users.
o 搜索应该由用户之间共享的URI表示。
- Such URIs should be long-term stable.
- 这样的URI应该是长期稳定的。
- The search may be re-executed when the URI is referenced. It is acceptable for the same URI to produce different results if accessed at different times or by different people (for example, by reflecting additional messages that may match the search criteria or reflecting changes in access authorization to lists with restricted archives).
- 当URI被引用时，可以重新执行搜索。如果在不同的时间或由不同的人访问同一个URI，则产生不同的结果是可以接受的（例如，通过反映可能与搜索条件匹配的附加消息或反映对具有受限存档的列表的访问授权的更改）。
o When the system requires credentials, it must use the datatracker's authentication system.
o 当系统需要凭据时，它必须使用datatracker的身份验证系统。
- While the vast majority of archived lists have an open access policy, some archived lists have restricted archives.
- 虽然绝大多数存档列表都有开放访问策略，但有些存档列表限制了存档。
- The system must not require credentials for browsing or searching lists with open archives. (But it is acceptable for a user to browse or search such lists while logged in.)
- 系统在浏览或搜索已打开存档的列表时不得要求凭据。（但用户可以在登录时浏览或搜索此类列表。）
- The system must make it possible to limit access to a restricted archive based on login credentials.
- 系统必须能够根据登录凭据限制对受限存档的访问。
- Messages from restricted archives must be distinguishable from messages from unrestricted archives in any search results.
- 在任何搜索结果中，来自受限存档的邮件必须与来自非受限存档的邮件区分开来。
o The archive system must accept messages handled by various mail list manager packages.
o 存档系统必须接受由各种邮件列表管理器包处理的邮件。
- Lists hosted on the IETF systems are served by Mailman [Mailman].
- IETF系统上的列表由邮递员[邮递员]提供服务。
- Lists hosted at other organizations may use other packages.
- 其他组织托管的列表可能会使用其他包。
* The archive system must accept messages through subscribing to such an external list.
* 存档系统必须通过订阅这样的外部列表来接受消息。
* The archive system may support other mechanisms for accepting messages into the archive.
* 归档系统可以支持其他机制，用于将消息接收到归档中。
Lists hosted at other systems are sometimes moved to the IETF servers, and their archive is moved with them. The archiving system must be able to import these archives.
托管在其他系统上的列表有时会移动到IETF服务器上，它们的存档也随之移动。存档系统必须能够导入这些存档。
o At a minimum, the archive system must be able to import mbox formatted archives [RFC4155] [Mbox].
o 存档系统至少必须能够导入mbox格式的存档[RFC4155][mbox]。
o The archive system should be able to import Maildir and Maildir-like (the key characteristic being one-message-per-file) formatted archives [Maildir].
o 归档系统应该能够导入Maildir和Maildir格式的归档文件[Maildir]。
o It is acceptable to use a separate utility to convert between these formats before import, as long as the conversion is lossless.
o 可以在导入之前使用单独的实用程序在这些格式之间进行转换，只要转换是无损的。
The archive system must allow both users and administrators to export messages.
存档系统必须允许用户和管理员导出邮件。
o The archive system must support exporting messages in the mbox format.
o 存档系统必须支持以mbox格式导出邮件。
o The archive system should support exporting messages in the Maildir format.
o 存档系统应支持以Maildir格式导出邮件。
o The archive system must support exporting the entire archive of a given list.
o 存档系统必须支持导出给定列表的整个存档。
o The archive system must support exporting all messages from a given list within a given date range.
o 存档系统必须支持导出给定日期范围内给定列表中的所有邮件。
o The archive system should allow exporting the results of any supported search query.
o 存档系统应允许导出任何受支持的搜索查询的结果。
o The systems must facilitate providing archive, search, and browse functions through geographically distributed servers.
o 系统必须有助于通过地理分布的服务器提供归档、搜索和浏览功能。
- The systems must support a single active and single standby server. This reflects the current operating configuration and is expected to be the initial deployment model.
- 系统必须支持单个活动和单个备用服务器。这反映了当前的操作配置，预计将成为初始部署模型。
- The systems should support a single active and multiple standby servers.
- 系统应支持单个活动服务器和多个备用服务器。
- The systems should support multiple active servers for the search and browse functions. Support for multiple active archive servers is not a requirement.
- 系统应支持多个活动服务器以实现搜索和浏览功能。不需要支持多个活动存档服务器。
- The amount of traffic generated to ensure data replication between servers should be on the order of the size of any new/ changed messages in the archives.
- 为确保服务器之间的数据复制而生成的通信量应与存档中任何新消息/更改消息的大小相同。
* It is acceptable for replication to be part of the archival system itself (such as using the replication mechanisms from an underlying database).
* 将复制作为存档系统本身的一部分是可以接受的（例如使用来自底层数据库的复制机制）。
* It is acceptable to rely on replication of the underlying filesystem objects (using rsync of one or more directory trees, for example), but only if the objects in the underlying filesystem are formatted such that the size of the replication data is on the order of the size of any new/ changed messages in the archives.
* 依赖底层文件系统对象的复制（例如，使用一个或多个目录树的rsync）是可以接受的，但前提是底层文件系统中的对象被格式化为复制数据的大小与存档中任何新的/更改的消息的大小相同。
o The archive system must support adding and removing lists to be archived.
o 存档系统必须支持添加和删除要存档的列表。
o The system must allow the administrator to add messages to and delete messages from an archived list. The system should log such actions.
o 系统必须允许管理员在存档列表中添加和删除邮件。系统应记录此类操作。
There are many existing archived messages containing embedded links into the existing MHonArc [MHonArc] mail archive. These links must continue to work, but they should reach the message as archived in the new system.
有许多现有的存档邮件包含嵌入现有MHonArc[MHonArc]邮件存档的链接。这些链接必须继续工作，但它们应该到达新系统中存档的邮件。
The archive and search functions should anticipate internationalized email addresses as discussed in the following three documents -- [RFC6531], [RFC6532], and [IMAP-UTF8]. There is no firm requirement at this time.
存档和搜索功能应预期国际化电子邮件地址，如以下三个文档所述--[RFC6531]、[RFC6532]和[IMAP-UTF8]。目前没有明确的要求。
Requirements for allowing access to the archives using IMAP are captured in [IMAP-ARCH]. The archive system must anticipate integrating with a system that provides IMAP access.
允许使用IMAP访问档案的要求见[IMAP-ARCH]。存档系统必须能够与提供IMAP访问的系统集成。
Creating a new tool for searching and archiving IETF email lists does not affect the security of the Internet in any significant fashion.
创建用于搜索和归档IETF电子邮件列表的新工具不会以任何显著方式影响互联网的安全。
Searching can be I/O and CPU intensive. The implementors of this tool should consider the potential for maliciously crafted searches attempting to consume all available resources. Similarly, the implementors should consider the potential for denial-of-service attacks through making many connections to the browsing system or rapid navigating within it.
搜索可能是I/O和CPU密集型的。该工具的实现者应该考虑恶意搜索的尝试，试图消耗所有可用的资源。类似地，实现者应该考虑通过与浏览系统的许多连接或在其内部快速导航来拒绝拒绝服务攻击的可能性。
Preserving the integrity of the archives is important. The implementors should ensure that administrative access is appropriately authenticated, and that message paths into the archive are appropriately configured to avoid unauthorized message insertion.
保持档案的完整性很重要。实现者应该确保管理访问经过适当的身份验证，并且归档中的消息路径经过适当的配置，以避免未经授权的消息插入。
The Tools Development team provided input into the initial brainstorm. Text suggestions from Alexey Melnikov, Pete Resnick, S. Moonesamy, Francis Dupont, and Murray Kucherawy have been incorporated.
工具开发团队为最初的头脑风暴提供了投入。Alexey Melnikov、Pete Resnick、S.Moonesay、Francis Dupont和Murray Kucherawy的文字建议已被纳入。
[IMAP-ARCH] Sparks, R., "IMAP Access to IETF Email List Archives", Work in Progress, August 2012.
[IMAP-ARCH]Sparks，R.，“IMAP访问IETF电子邮件列表档案”，正在进行的工作，2012年8月。
[IMAP-UTF8] Resnick, P., Ed., Newman, C., Ed., and S. Shen, Ed., "IMAP Support for UTF-8", Work in Progress, October 2012.
[IMAP-UTF8]Resnick，P.，Ed.，Newman，C.，Ed.，和S.Shen，Ed.，“UTF-8的IMAP支持”，正在进行的工作，2012年10月。
[Maildir] "Maildir", <http://en.wikipedia.org/w/ index.php?title=Maildir&oldid=503288041>.
[Maildir]“Maildir”<http://en.wikipedia.org/w/ index.php？title=Maildir&oldid=503288041>。
[Mailman] "Mailman", <http://www.list.org/>.
[邮递员]“邮递员”<http://www.list.org/>.
[Mbox] "mbox", <http://en.wikipedia.org/w/ index.php?title=Mbox&oldid=515402275>.
[Mbox]“Mbox”<http://en.wikipedia.org/w/ index.php？title=Mbox&oldid=515402275>。
[MHonArc] "MHonArc", <http://www.mhonarc.org/>.
[MHonArc]“MHonArc”<http://www.mhonarc.org/>.
[RFC4155] Hall, E., "The application/mbox Media Type", RFC 4155, September 2005.
[RFC4155]Hall，E.“应用程序/mbox媒体类型”，RFC 4155，2005年9月。
[RFC5064] Duerst, M., "The Archived-At Message Header Field", RFC 5064, December 2007.
[RFC5064]Duerst，M.“在消息头字段存档”，RFC 5064，2007年12月。
[RFC6531] Yao, J. and W. Mao, "SMTP Extension for Internationalized Email", RFC 6531, February 2012.
[RFC6531]Yao，J.和W.Mao，“国际化电子邮件的SMTP扩展”，RFC 65312012年2月。
[RFC6532] Yang, A., Steele, S., and N. Freed, "Internationalized Email Headers", RFC 6532, February 2012.
[RFC6532]Yang，A.，Steele，S.，和N.Freed，“国际化电子邮件标题”，RFC 6532，2012年2月。
Author's Address
作者地址
Robert Sparks Tekelec 17210 Campbell Road Suite 250 Dallas, Texas 75254-4203 USA
美国德克萨斯州达拉斯市坎贝尔路250号Robert Sparks Tekelec 17210套房75254-4203
EMail: RjS@nostrum.com
EMail: RjS@nostrum.com