RFC 8438 - IMAP Extension for STATUS=SIZE 日本語訳

原文URL : https://datatracker.ietf.org/doc/html/rfc8438
タイトル : RFC 8438 - STATUS = SIZEのIMAP拡張
翻訳編集 : 自動生成

[要約] RFC 8438は、IMAP拡張機能であるSTATUS=SIZEに関する仕様を定めています。この拡張機能の目的は、メールボックス内のメッセージのサイズ情報を効率的に取得することです。

Internet Engineering Task Force (IETF)                          S. Bosch
Request for Comments: 8438                                    Dovecot Oy
Category: Standards Track                                    August 2018
ISSN: 2070-1721

IMAP Extension for STATUS=SIZE

STATUS = SIZEのIMAP拡張

Abstract

概要

This document adds a new capability called "STATUS=SIZE" to the Internet Message Access Protocol (IMAP). It allows retrieving the total storage size of a mailbox with a single STATUS command rather than retrieving and summing the sizes of all individual messages in that mailbox.

このドキュメントは、インターネットメッセージアクセスプロトコル（IMAP）に「STATUS = SIZE」という新しい機能を追加します。メールボックス内のすべての個別メッセージのサイズを取得して合計するのではなく、1つのSTATUSコマンドでメールボックスの合計ストレージサイズを取得できます。

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/rfc8438.

このドキュメントの現在のステータス、エラッタ、およびフィードバックの提供方法に関する情報は、https：//www.rfc-editor.org/info/rfc8438で入手できます。

著作権表示

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.  STATUS Command and Response Extensions  . . . . . . . . . . .   3
   4.  Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . .   5
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   5
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   5
   7.  Normative References  . . . . . . . . . . . . . . . . . . . .   5
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .   6
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   6

1. Introduction

1. はじめに

This document extends the Internet Message Access Protocol (IMAP) [IMAP4rev1] with a new capability called "STATUS=SIZE". To determine the total storage size of a mailbox, an IMAP client currently needs to retrieve all message sizes individually using the FETCH command with the RFC822.SIZE data item. The STATUS=SIZE capability provides a more efficient means of achieving this. It extends the STATUS command with a new "SIZE" data item, which indicates the total size of all messages in the target mailbox. This way, this information can be queried with just one STATUS command. When the LIST-STATUS IMAP capability [LIST-STATUS] is also available, the SIZE data item can be queried for many mailboxes at once using just one LIST command.

このドキュメントは、インターネットメッセージアクセスプロトコル（IMAP）[IMAP4rev1]を「STATUS = SIZE」という新しい機能で拡張したものです。メールボックスの合計ストレージサイズを決定するために、IMAPクライアントは現在、RFC822.SIZEデータ項目を指定したFETCHコマンドを使用して、すべてのメッセージサイズを個別に取得する必要があります。 STATUS = SIZE機能は、これを達成するためのより効率的な手段を提供します。ターゲットメールボックス内のすべてのメッセージの合計サイズを示す新しい "SIZE"データ項目でSTATUSコマンドを拡張します。このように、この情報は、1つのSTATUSコマンドで照会できます。 LIST-STATUS IMAP機能[LIST-STATUS]も使用できる場合、1つのLISTコマンドを使用するだけで、多数のメールボックスに対してSIZEデータ項目を一度にクエリできます。

This capability is particularly useful for IMAP clients that do not cache the state of the message store, such as most webmail clients. Without the "STATUS=SIZE" capability, such clients need to fetch all message sizes from the server when the size of an individual mailbox needs to be determined. For example, a user may request detailed quota usage information for each mailbox to find out which specific mailboxes consume most of the available storage resources. Using this information, the user can get an overview of which mailboxes need to be cleaned up to reduce quota usage. The QUOTA capability [QUOTA] is no help in that scenario, since the provided QUOTAROOT command can only yield the STORAGE resource usage of a whole quota root, not each individual mailbox within that root.

この機能は、ほとんどのWebメールクライアントなど、メッセージストアの状態をキャッシュしないIMAPクライアントに特に役立ちます。「STATUS = SIZE」機能がない場合、個々のメールボックスのサイズを決定する必要がある場合、そのようなクライアントはサーバーからすべてのメッセージサイズをフェッチする必要があります。たとえば、ユーザーは各メールボックスの詳細なクォータ使用情報を要求して、使用可能なストレージリソースのほとんどを消費している特定のメールボックスを見つけることができます。この情報を使用して、ユーザーは、クォータの使用を減らすためにクリーンアップする必要があるメールボックスの概要を取得できます。提供されたQUOTAROOTコマンドは、そのルート内の個々のメールボックスではなく、クォータルート全体のSTORAGEリソース使用量のみを生成できるため、QUOTA機能[QUOTA]はそのシナリオでは役に立ちません。

2. Conventions Used in This Document

2. このドキュメントで使用される規則

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] [KEYWORDS2] 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] [KEYWORDS2]で説明されているように解釈されます。

3. STATUS Command and Response Extensions

3. STATUSコマンドと応答の拡張

This extension defines one new status data item for the STATUS command and response:

この拡張機能は、STATUSコマンドと応答の1つの新しいステータスデータ項目を定義します。

SIZE The total size of the mailbox in octets. This is not strictly required to be an exact value, but it MUST be equal to or greater than the sum of the values of the RFC822.SIZE FETCH message data item [IMAP4rev1] of all messages in the mailbox. When the QUOTA capability [QUOTA] is also supported, this value SHOULD be equal to the storage usage value used to enforce the STORAGE resource limit for this mailbox. This way, the client can directly infer the quota usage.

SIZEオクテット単位のメールボックスの合計サイズ。これは厳密な値である必要はありませんが、メールボックス内のすべてのメッセージのRFC822.SIZE FETCHメッセージデータ項目[IMAP4rev1]の値の合計以上でなければなりません。 QUOTA機能[QUOTA]もサポートされている場合、この値は、このメールボックスのSTORAGEリソース制限を適用するために使用されるストレージ使用量の値と等しい必要があります（SHOULD）。このようにして、クライアントはクォータの使用状況を直接推測できます。

Since the total storage size of a mailbox can easily exceed 4 GB, clients MUST be capable of receiving 63-bit SIZE data item values. The message size is chosen to be at most 63 bits wide rather than 64 bits to make implementations on various platforms (such as Java) easier.

メールボックスの合計ストレージサイズは4 GBを簡単に超える可能性があるため、クライアントは63ビットのSIZEデータ項目値を受信できる必要があります。メッセージサイズは、さまざまなプラットフォーム（Javaなど）での実装を容易にするために、64ビットではなく最大63ビット幅になるように選択されます。

Example:

例：

   C: A01 STATUS frop (MESSAGES SIZE UIDNEXT)
   S: * STATUS frop (MESSAGES 8 SIZE 44421 UIDNEXT 242344)
   S: A01 OK STATUS completed
   The same information can be obtained by using the following commands,
   albeit less efficiently:

   C: A02 SELECT "frop"
   S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
   S: * 8 EXISTS
   S: * 1 RECENT
   S: * OK [UNSEEN 7] First unseen.
   S: * OK [UIDVALIDITY 1364851417] UIDs valid
   S: * OK [UIDNEXT 242344] Predicted next UID
   S: * OK [HIGHESTMODSEQ 3914] Highest
   S: A02 OK [READ-WRITE] Select completed.
   C: A03 FETCH 1:* (RFC822.SIZE)
   S: * 1 FETCH (RFC822.SIZE 3224)
   S: * 2 FETCH (RFC822.SIZE 1222)
   S: * 3 FETCH (RFC822.SIZE 444)
   S: * 4 FETCH (RFC822.SIZE 4516)
   S: * 5 FETCH (RFC822.SIZE 544)
   S: * 6 FETCH (RFC822.SIZE 922)
   S: * 7 FETCH (RFC822.SIZE 31126)
   S: * 8 FETCH (RFC822.SIZE 2423)
   S: A03 OK Fetch completed.

When the LIST-STATUS IMAP capability [LIST-STATUS] is also available, the STATUS command can be combined with the LIST command to further improve efficiency. This way, the sizes of many mailboxes can be queried with just one LIST command.

LIST-STATUS IMAP機能[LIST-STATUS]も使用できる場合は、STATUSコマンドをLISTコマンドと組み合わせてさらに効率を向上させることができます。このように、1つのLISTコマンドで多くのメールボックスのサイズを照会できます。

Example:

例：

   C: A04 LIST "" % RETURN (STATUS (MESSAGES SIZE))
   S: * LIST () "." "INBOX"
   S: * STATUS "INBOX" (MESSAGES 17 SIZE 16234)
   S: * LIST () "." "frop"
   S: * STATUS "frop" (MESSAGES 8 SIZE 44421)
   S: A04 OK List completed.

4. Formal Syntax

4. 正式な構文

The following syntax specification augments the grammar specified in [IMAP4rev1] and [IMAP4-ABNF]. It uses the Augmented Backus-Naur Form (ABNF) notation as specified in [ABNF]. Elements not defined here are taken from [IMAP4rev1] and [IMAP4-ABNF].

次の構文仕様は、[IMAP4rev1]および[IMAP4-ABNF]で指定された文法を補強します。 [ABNF]で指定されているように、拡張バッカスナウルフォーム（ABNF）表記を使用します。ここで定義されていない要素は、[IMAP4rev1]および[IMAP4-ABNF]から取得されます。

   capability     =/ "STATUS=SIZE"

status-att =/ "SIZE"

status-att = / "SIZE"

status-att-val =/ "SIZE" SP number64

status-to-selection = / "SIZE" SP number64

   number64       = 1*DIGIT
                    ; Unsigned 63-bit integer
                    ; (0 <= n <= 9,223,372,036,854,775,807)

5. Security Considerations

5. セキュリティに関する考慮事項

There are no known additional security issues with this extension beyond those described for the base protocol [IMAP4rev1] and the LIST-STATUS extension [LIST-STATUS].

この拡張機能には、基本プロトコル[IMAP4rev1]とLIST-STATUS拡張機能[LIST-STATUS]について説明されているもの以外に、既知の追加のセキュリティ問題はありません。

6. IANA Considerations

6. IANAに関する考慮事項

IANA has added "STATUS=SIZE" to the "IMAP Capabilities" registry located at <http://www.iana.org/assignments/imap-capabilities>.

IANAは、<http://www.iana.org/assignments/imap-capabilities>にある「IMAP Capabilities」レジストリに「STATUS = SIZE」を追加しました。

7. Normative References

7. 引用文献

[ABNF] 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>.

[ABNF]クロッカー、D。、エド。およびP. Overell、「構文仕様の拡張BNF：ABNF」、STD 68、RFC 5234、DOI 10.17487 / RFC5234、2008年1月、<https://www.rfc-editor.org/info/rfc5234>。

[IMAP4-ABNF] Melnikov, A. and C. Daboo, "Collected Extensions to IMAP4 ABNF", RFC 4466, DOI 10.17487/RFC4466, April 2006, <https://www.rfc-editor.org/info/rfc4466>.

[IMAP4-ABNF] Melnikov、A。およびC. Daboo、「IMAP4 ABNFに対する収集された拡張機能」、RFC 4466、DOI 10.17487 / RFC4466、2006年4月、<https://www.rfc-editor.org/info/rfc4466> 。

[IMAP4rev1] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 3501, DOI 10.17487/RFC3501, March 2003, <https://www.rfc-editor.org/info/rfc3501>.

[IMAP4rev1] Crispin、M。、「インターネットメッセージアクセスプロトコル-バージョン4rev1」、RFC 3501、DOI 10.17487 / RFC3501、2003年3月、<https://www.rfc-editor.org/info/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/info/rfc2119>.

[キーワード] Bradner、S.、「要件レベルを示すためにRFCで使用するキーワード」、BCP 14、RFC 2119、DOI 10.17487 / RFC2119、1997年3月、<https://www.rfc-editor.org/info/ rfc2119>。

[KEYWORDS2] 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>.

[KEYWORDS2] Leiba、B.、「あいまいな大文字と小文字のRFC 2119キーワード」、BCP 14、RFC 8174、DOI 10.17487 / RFC8174、2017年5月、<https://www.rfc-editor.org/info/ rfc8174>。

[LIST-STATUS] 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>.

[リストステータス] Melnikov、A。およびT. Sirainen、「拡張リストでステータス情報を返すためのIMAP4拡張機能」、RFC 5819、DOI 10.17487 / RFC5819、2010年3月、<https://www.rfc-editor.org/ info / rfc5819>。

[QUOTA] Myers, J., "IMAP4 QUOTA extension", RFC 2087, DOI 10.17487/RFC2087, January 1997, <https://www.rfc-editor.org/info/rfc2087>.

[QUOTA]マイヤーズJ。、「IMAP4 QUOTA拡張機能」、RFC 2087、DOI 10.17487 / RFC2087、1997年1月、<https://www.rfc-editor.org/info/rfc2087>。

Acknowledgements

謝辞

Thanks to Bron Gondwana, Alexey Melnikov, Stan Kalisch, and Michael Slusarz for reviews and suggestions.

レビューと提案をしてくれたBron Gondwana、Alexey Melnikov、Stan Kalisch、Michael Slusarzに感謝します。

Author's Address

著者のアドレス

Stephan Bosch Dovecot Oy Lars Sonckin Kaari 12 Espoo 02600 Finland

Stephan Bosch Dovecot Oy Lars Sonckin Kaari 12 Espoo 02600フィンランド

   Email: stephan.bosch@dovecot.fi