[要約] RFC 8514は、IMAPプロトコルの拡張であるSAVEDATEの仕様を定義しています。SAVEDATE拡張は、メールボックス内のメッセージの保存日時を取得するために使用されます。
Internet Engineering Task Force (IETF) S. Bosch Request for Comments: 8514 Open Xchange Oy Category: Standards Track January 2019 ISSN: 2070-1721
Internet Message Access Protocol (IMAP) - SAVEDATE Extension
インターネットメッセージアクセスプロトコル(IMAP)-SAVEDATE拡張機能
Abstract
概要
This document adds a new capability called "SAVEDATE" to the Internet Message Access Protocol (IMAP). It defines a new IMAP message attribute called "save date" that, unlike the existing "internal date" attribute, always indicates the moment at which the message was saved in its current mailbox. The SAVEDATE capability extends the FETCH command with the means to retrieve the save date attribute and extends the SEARCH command to allow using the save date attribute in searching criteria.
このドキュメントは、インターネットメッセージアクセスプロトコル(IMAP)に「SAVEDATE」と呼ばれる新機能を追加します。これは、「保存日」と呼ばれる新しいIMAPメッセージ属性を定義します。これは、既存の「内部日付」属性とは異なり、メッセージが現在のメールボックスに保存された瞬間を常に示します。 SAVEDATE機能は、保存日付属性を取得する手段でFETCHコマンドを拡張し、検索基準で保存日付属性を使用できるようにSEARCHコマンドを拡張します。
Status of This Memo
本文書の状態
This is an Internet Standards Track document.
これはInternet Standards Trackドキュメントです。
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(Internet Engineering Task Force)の製品です。これは、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/rfc8514.
このドキュメントの現在のステータス、エラータ、およびフィードバックの提供方法に関する情報は、https://www.rfc-editor.org/info/rfc8514で入手できます。
Copyright Notice
著作権表示
Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved.
Copyright(c)2019 IETF Trustおよびドキュメントの作成者として識別された人物。全著作権所有。
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)の対象であり、この文書の発行日に有効です。これらのドキュメントは、このドキュメントに関するあなたの権利と制限を説明しているため、注意深く確認してください。このドキュメントから抽出されたコードコンポーネントには、Trust Legal Provisionsのセクション4.eに記載されているSimplified BSD Licenseのテキストが含まれている必要があり、Simplified BSD Licenseに記載されているように保証なしで提供されます。
Table of Contents
目次
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Conventions Used in This Document . . . . . . . . . . . . . . 3 3. Save Date Message Attribute . . . . . . . . . . . . . . . . . 3 4. IMAP Protocol Changes . . . . . . . . . . . . . . . . . . . . 4 4.1. CAPABILITY Identification . . . . . . . . . . . . . . . . 4 4.2. FETCH Command and Response Extensions . . . . . . . . . . 4 4.3. SEARCH Command Extension . . . . . . . . . . . . . . . . 4 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 5 6. Security Considerations . . . . . . . . . . . . . . . . . . . 5 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 8. Normative References . . . . . . . . . . . . . . . . . . . . 6 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 7 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 7
This document extends the Internet Message Access Protocol (IMAP) [IMAP4rev1] with a new capability called "SAVEDATE". This capability adds a new IMAP message attribute called "save date". The save date is the date and time at which a message was saved in the mailbox in which it currently resides. The save date is similar to the existing "internal date" attribute in that it is set at the time of delivery. However, the internal date attribute can be set to an arbitrary value for messages delivered to the mailbox using the APPEND command and is usually copied from the source message for messages delivered using the COPY command. In contrast, the save date attribute is always set to the current date and time at the moment the message is saved in the mailbox, irrespective of how the message is delivered and from where it originates.
このドキュメントは、インターネットメッセージアクセスプロトコル(IMAP)[IMAP4rev1]を「SAVEDATE」という新しい機能で拡張したものです。この機能により、「保存日」と呼ばれる新しいIMAPメッセージ属性が追加されます。保存日は、メッセージが現在存在するメールボックスにメッセージが保存された日時です。保存日は、配信時に設定されるという点で、既存の「内部日付」属性と同様です。ただし、内部日付属性は、APPENDコマンドを使用してメールボックスに配信されたメッセージの任意の値に設定でき、通常、COPYコマンドを使用して配信されたメッセージのソースメッセージからコピーされます。対照的に、保存日属性は、メッセージがどのように配信され、どこから発信されたかに関係なく、メッセージがメールボックスに保存された瞬間の現在の日時に常に設定されます。
The save date attribute is useful for implementing automated removal of messages from a mailbox after a configured amount of time. For that application, it is necessary to know when the message was saved in the mailbox, which cannot be reliably determined using the internal date attribute.
保存日属性は、構成された時間が経過した後、メールボックスからメッセージの自動削除を実装するのに役立ちます。このアプリケーションでは、メッセージがメールボックスにいつ保存されたかを知る必要があります。これは、内部日付属性を使用して確実に決定することはできません。
For example, a common client usage pattern is to move deleted messages to a Trash mailbox. These messages are considered "deleted" at the time they are moved to the Trash mailbox. In an effort to limit the size of the Trash mailbox, a client may subsequently desire to permanently remove (expunge) all messages in that Trash mailbox deleted before a certain time (e.g., a configurable expiration interval). In that case, the internal date attribute cannot be used since it likely refers to the time at which the message was originally received. The proper time comparison attribute should instead be the time at which the message was saved to the Trash mailbox. Similar usage patterns can be observed for archiving solutions.
たとえば、一般的なクライアントの使用パターンは、削除されたメッセージをゴミ箱メールボックスに移動することです。これらのメッセージは、ゴミ箱メールボックスに移動された時点で「削除」されたと見なされます。ごみ箱メールボックスのサイズを制限するために、クライアントはその後、特定の時間(たとえば、構成可能な有効期限間隔)の前に削除されたごみ箱メールボックス内のすべてのメッセージを完全に削除(消去)することを望む場合があります。その場合、内部日付属性は、メッセージが最初に受信された時刻を参照している可能性があるため、使用できません。適切な時刻比較属性は、メッセージがゴミ箱メールボックスに保存された時刻である必要があります。アーカイブソリューションでも同様の使用パターンが見られます。
The SAVEDATE capability extends the FETCH command and response to allow retrieving the date and time at which a message was saved. Also, the SAVEDATE capability extends the SEARCH command to allow searching messages with criteria based on when they were saved in the mailbox.
SAVEDATE機能は、FETCHコマンドと応答を拡張して、メッセージが保存された日時を取得できるようにします。また、SAVEDATE機能はSEARCHコマンドを拡張して、メールボックスにいつ保存されたかに基づいて、条件付きのメッセージを検索できるようにします。
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 [KEYWORDS] [KEYWORDS-UPD] when, and only when, they appear in all capitals, as shown here.
キーワード「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「SHOULD」、「SHOULD NOT」、「RECOMMENDED」、「NOT RECOMMENDED」、「MAY」、「OPTIONALこのドキュメントの「」は、BCP 14 [KEYWORDS] [KEYWORDS-UPD]で説明されているように解釈されます。
The save date message attribute is the date and time at which the message was saved in the mailbox it is now located in. Unlike the internal date message attribute defined by [IMAP4rev1], this date and time value cannot be set arbitrarily when a message is delivered by the IMAP APPEND command. Also, when a message is delivered to the mailbox by the IMAP COPY command [IMAP4rev1] or the IMAP MOVE command [IMAP-MOVE], the save date attribute is not copied from the source message. Instead, the current date and time at which the message is delivered to a mailbox MUST be used to set the save date attribute. Once calculated, the save date attribute MUST NOT change as long as the message is contained within the same mailbox.
保存日付メッセージ属性は、メッセージが現在配置されているメールボックスにメッセージが保存された日付と時刻です。[IMAP4rev1]で定義されている内部日付メッセージ属性とは異なり、この日付と時刻の値は、メッセージがIMAP APPENDコマンドによって配信されます。また、IMAP COPYコマンド[IMAP4rev1]またはIMAP MOVEコマンド[IMAP-MOVE]によってメッセージがメールボックスに配信される場合、保存日属性はソースメッセージからコピーされません。代わりに、メッセージがメールボックスに配信される現在の日付と時刻を使用して、保存日属性を設定する必要があります。計算後は、メッセージが同じメールボックス内に含まれている限り、保存日付属性を変更してはなりません。
This means that when the message is copied to another mailbox, the save date of the message in the source mailbox remains unaffected; only the new copy of the message gets a new save date. Consequently, when the message is moved to another mailbox, either using the MOVE command or a command sequence involving the COPY command [IMAP-MOVE], the message always gets a new save date in the destination mailbox.
つまり、メッセージが別のメールボックスにコピーされても、ソースメールボックスでのメッセージの保存日は影響を受けません。メッセージの新しいコピーのみが新しい保存日を取得します。したがって、MOVEコマンドまたはCOPYコマンド[IMAP-MOVE]を含むコマンドシーケンスを使用してメッセージを別のメールボックスに移動すると、メッセージは常に宛先メールボックスに新しい保存日を取得します。
For some specific mailboxes, the underlying storage may not support the save date attribute. The handling of this situation is described in detail in the next section for each involved IMAP command.
一部の特定のメールボックスでは、基になるストレージが保存日属性をサポートしていない場合があります。この状況の処理については、関連する各IMAPコマンドについて次のセクションで詳しく説明します。
IMAP servers that support this extension MUST include "SAVEDATE" in the response list to the CAPABILITY command.
この拡張機能をサポートするIMAPサーバーは、CAPABILITYコマンドへの応答リストに「SAVEDATE」を含める必要があります。
This extension defines one new data item for the FETCH command:
この拡張機能は、FETCHコマンドの1つの新しいデータ項目を定義します。
SAVEDATE The save date of the message.
SAVEDATEメッセージの保存日。
This extension defines one new data item for the FETCH response:
この拡張機能は、FETCH応答の1つの新しいデータ項目を定義します。
SAVEDATE A string representing the save date of the message. However, if the underlying mailbox storage does not support the save date message attribute, the value returned for the SAVEDATE item is always NIL, rather than a string.
SAVEDATEメッセージの保存日を表す文字列。ただし、基になるメールボックスストレージが保存日付メッセージ属性をサポートしていない場合、SAVEDATEアイテムに対して返される値は、文字列ではなく常にNILです。
Example:
例:
C: A101 FETCH 998 (SAVEDATE) S: * 998 FETCH (SAVEDATE "01-Jan-2015 18:50:53 +0100") S: A101 OK Fetch completed.
This extension defines four new search keys for the SEARCH command:
この拡張機能は、SEARCHコマンドの4つの新しい検索キーを定義します。
SAVEDBEFORE <date> Messages whose save date (disregarding time and timezone) is earlier than the specified date.
SAVEDBEFORE <日付>保存日付(時間とタイムゾーンを除く)が指定された日付より前のメッセージ。
SAVEDON <date> Messages whose save date (disregarding time and timezone) is within the specified date.
SAVEDON <date>保存時刻(時間とタイムゾーンを除く)が指定された日付内にあるメッセージ。
SAVEDSINCE <date> Messages whose save date (disregarding time and timezone) is within or later than the specified date.
SAVEDSINCE <date>保存日付(時間とタイムゾーンに関係なく)が指定された日付以内であるメッセージ。
SAVEDATESUPPORTED Matches all messages in the mailbox when the underlying storage of that mailbox supports the save date attribute. Conversely, it matches no messages in the mailbox when the save date attribute is not supported.
SAVEDATESUPPORTEDメールボックスの基になるストレージが保存日付属性をサポートしている場合、メールボックス内のすべてのメッセージに一致します。逆に、保存日付属性がサポートされていない場合は、メールボックス内のどのメッセージとも一致しません。
When the underlying storage of a mailbox does not support the save date attribute, the SAVEDBEFORE, SAVEDON, and SAVEDSINCE search keys MUST use the internal date attribute instead. In the context of the IMAP Multimailbox SEARCH Extension [MULTISEARCH], this fallback behavior MUST apply to each mailbox individually, meaning that only the mailboxes that lack support for the save date attribute use the internal date attribute instead.
メールボックスの基になるストレージが保存日付属性をサポートしていない場合、SAVEDBEFORE、SAVEDON、およびSAVEDSINCE検索キーは、代わりに内部日付属性を使用する必要があります。 IMAPマルチメールボックス検索拡張機能[マルチ検索]のコンテキストでは、このフォールバック動作は各メールボックスに個別に適用する必要があります。つまり、保存日付属性のサポートがないメールボックスのみが代わりに内部日付属性を使用します。
Example:
例:
C: A102 SEARCH SAVEDON 28-Dec-2014 S: * SEARCH 993 994 S: A102 OK Search completed. C: A103 SEARCH SAVEDSINCE 28-Dec-2014 S: * SEARCH 993 994 995 996 997 998 999 1000 1001 S: A103 OK Search completed.
The following syntax specification augments the grammar specified in [IMAP4rev1]. It uses the Augmented Backus-Naur Form (ABNF) notation as specified in [ABNF]. Elements not defined here are taken from [IMAP4rev1].
次の構文仕様は、[IMAP4rev1]で指定された文法を補強します。 [ABNF]で指定されているように、拡張バッカスナウルフォーム(ABNF)表記を使用します。ここで定義されていない要素は、[IMAP4rev1]から取得されます。
capability =/ "SAVEDATE"
機能= / "SAVEDATE"
fetch-att =/ "SAVEDATE"
fetch-att = / "SAVEDATE"
msg-att-static =/ "SAVEDATE" SP (date-time / nil)
search-key =/ "SAVEDBEFORE" SP date / "SAVEDON" SP date / "SAVEDSINCE" SP date / "SAVEDATESUPPORTED"
search-key = / "SAVEDBEFORE" SP日付/ "SAVEDON" SP日付/ "SAVEDSINCE" SP日付/ "SAVEDATESUPPORTED"
There are no known additional security issues with this extension beyond those described in the base protocol described in [IMAP4rev1].
[IMAP4rev1]で説明されている基本プロトコルで説明されている問題以外に、この拡張機能に関する既知の追加のセキュリティ問題はありません。
IANA has added "SAVEDATE" to the "IMAP Capabilities" registry located at <https://www.iana.org/assignments/imap-capabilities>.
IANAは、<https://www.iana.org/assignments/imap-capabilities>にある「IMAP Capabilities」レジストリに「SAVEDATE」を追加しました。
[ABNF] Crocker, D. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, DOI 10.17487/RFC5234, January 2008, <https://www.rfc-editor.org/rfc/rfc5234>.
[ABNF] Crocker、D。およびP. Overell、「構文仕様の拡張BNF:ABNF」、STD 68、RFC 5234、DOI 10.17487 / RFC5234、2008年1月、<https://www.rfc-editor.org/rfc / rfc5234>。
[IMAP-MOVE] Gulbrandsen, A. and N. Freed, "Internet Message Access Protocol (IMAP) - MOVE Extension", RFC 6851, DOI 10.17487/RFC6851, January 2013, <https://www.rfc-editor.org/rfc/rfc6851>.
[IMAP-MOVE] Gulbrandsen、A。およびN. Freed、「インターネットメッセージアクセスプロトコル(IMAP)-MOVE拡張機能」、RFC 6851、DOI 10.17487 / RFC6851、2013年1月、<https://www.rfc-editor.org / rfc / rfc6851>。
[IMAP4rev1] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 3501, DOI 10.17487/RFC3501, March 2003, <https://www.rfc-editor.org/rfc/rfc3501>.
[IMAP4rev1] Crispin、M。、「インターネットメッセージアクセスプロトコル-バージョン4rev1」、RFC 3501、DOI 10.17487 / RFC3501、2003年3月、<https://www.rfc-editor.org/rfc/rfc3501>。
[KEYWORDS] 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/rfc/rfc2119>.
[キーワード] Bradner、S。、「要件レベルを示すためにRFCで使用するキーワード」、BCP 14、RFC 2119、DOI 10.17487 / RFC2119、1997年3月、<https://www.rfc-editor.org/rfc/ rfc2119>。
[KEYWORDS-UPD] 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>.
[KEYWORDS-UPD] Leiba、B。、「RFC 2119キーワードの大文字と小文字のあいまいさ」、BCP 14、RFC 8174、DOI 10.17487 / RFC8174、2017年5月、<https://www.rfc-editor.org/ info / rfc8174>。
[MULTISEARCH] Leiba, B. and A. Melnikov, "IMAP4 Multimailbox SEARCH Extension", RFC 7377, DOI 10.17487/RFC7377, October 2014, <https://www.rfc-editor.org/info/rfc7377>.
[マルチサーチ] Leiba、B。およびA. Melnikov、「IMAP4 Multimailbox SEARCH Extension」、RFC 7377、DOI 10.17487 / RFC7377、2014年10月、<https://www.rfc-editor.org/info/rfc7377>。
Acknowledgements
謝辞
Thanks to Bron Gondwana, Alexey Melnikov, Timo Sirainen, and Michael Slusarz for reviews and suggestions.
レビューと提案をしてくれたBron Gondwana、Alexey Melnikov、Timo Sirainen、Michael Slusarzに感謝します。
Author's Address
著者のアドレス
Stephan Bosch Open Xchange Oy Lars Sonckin kaari 12 Espoo 02600 Finland
ステファンボッシュオープンエクスチェンジオイラースソンクのアーチ12エスポー02600フィンランド
Email: stephan.bosch@open-xchange.com