| < draft-ietf-extra-imap-status-size-00.txt | draft-ietf-extra-imap-status-size-01.txt > | |||
|---|---|---|---|---|
| EXTRA S. Bosch | EXTRA S. Bosch | |||
| Internet-Draft Dovecot Oy | Internet-Draft Dovecot Oy | |||
| Intended status: Standards Track January 7, 2018 | Intended status: Standards Track March 24, 2018 | |||
| Expires: July 11, 2018 | Expires: September 25, 2018 | |||
| Internet Message Access Protocol (IMAP) - STATUS=SIZE Extension | Internet Message Access Protocol (IMAP) - STATUS=SIZE Extension | |||
| draft-ietf-extra-imap-status-size-00 | draft-ietf-extra-imap-status-size-01 | |||
| Abstract | Abstract | |||
| This document adds a new capability called "STATUS=SIZE" to the | This document adds a new capability called "STATUS=SIZE" to the | |||
| Internet Message Access Protocol (IMAP). It allows retrieving the | Internet Message Access Protocol (IMAP). It allows retrieving the | |||
| total storage size of a mailbox with a single STATUS command rather | total storage size of a mailbox with a single STATUS command rather | |||
| than retrieving and summing the sizes of all individual messages in | than retrieving and summing the sizes of all individual messages in | |||
| that mailbox. | that mailbox. | |||
| Status of This Memo | Status of This Memo | |||
| skipping to change at page 1, line 34 ¶ | skipping to change at page 1, line 34 ¶ | |||
| Internet-Drafts are working documents of the Internet Engineering | Internet-Drafts are working documents of the Internet Engineering | |||
| Task Force (IETF). Note that other groups may also distribute | Task Force (IETF). Note that other groups may also distribute | |||
| working documents as Internet-Drafts. The list of current Internet- | working documents as Internet-Drafts. The list of current Internet- | |||
| Drafts is at http://datatracker.ietf.org/drafts/current/. | Drafts is at http://datatracker.ietf.org/drafts/current/. | |||
| Internet-Drafts are draft documents valid for a maximum of six months | Internet-Drafts are draft documents valid for a maximum of six months | |||
| and may be updated, replaced, or obsoleted by other documents at any | and may be updated, replaced, or obsoleted by other documents at any | |||
| time. It is inappropriate to use Internet-Drafts as reference | time. It is inappropriate to use Internet-Drafts as reference | |||
| material or to cite them other than as "work in progress." | material or to cite them other than as "work in progress." | |||
| This Internet-Draft will expire on July 11, 2018. | This Internet-Draft will expire on September 25, 2018. | |||
| Copyright Notice | Copyright Notice | |||
| Copyright (c) 2018 IETF Trust and the persons identified as the | Copyright (c) 2018 IETF Trust and the persons identified as the | |||
| document authors. All rights reserved. | document authors. All rights reserved. | |||
| This document is subject to BCP 78 and the IETF Trust's Legal | This document is subject to BCP 78 and the IETF Trust's Legal | |||
| Provisions Relating to IETF Documents | Provisions Relating to IETF Documents | |||
| (http://trustee.ietf.org/license-info) in effect on the date of | (http://trustee.ietf.org/license-info) in effect on the date of | |||
| publication of this document. Please review these documents | publication of this document. Please review these documents | |||
| skipping to change at page 3, line 11 ¶ | skipping to change at page 3, line 11 ¶ | |||
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | |||
| "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this | "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this | |||
| document are to be interpreted as described in [KEYWORDS]. | document are to be interpreted as described in [KEYWORDS]. | |||
| 3. STATUS Command and Response Extensions | 3. STATUS Command and Response Extensions | |||
| This extension defines one new status data item for the STATUS | This extension defines one new status data item for the STATUS | |||
| command and response: | command and response: | |||
| SIZE | SIZE | |||
| The total size of the mailbox in octets. This MUST be equal to | The total size of the mailbox in octets. This is not strictly | |||
| the sum of the values of the RFC822.SIZE FETCH message data item | required to be an exact value, but it MUST be equal to or greater | |||
| [IMAP4rev1] of all messages in the mailbox. | 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. | ||||
| Example: | Example: | |||
| C: A01 STATUS frop (MESSAGES SIZE UIDNEXT) | C: A01 STATUS frop (MESSAGES SIZE UIDNEXT) | |||
| S: * STATUS frop (MESSAGES 8 SIZE 44421 UIDNEXT 242344) | S: * STATUS frop (MESSAGES 8 SIZE 44421 UIDNEXT 242344) | |||
| S: A01 OK STATUS completed | S: A01 OK STATUS completed | |||
| The same information can be obtained by using the following commands, | The same information can be obtained by using the following commands, | |||
| albeit less efficient: | albeit less efficient: | |||
| skipping to change at page 4, line 6 ¶ | skipping to change at page 4, line 8 ¶ | |||
| S: A03 OK Fetch completed. | S: A03 OK Fetch completed. | |||
| When the LIST-STATUS IMAP capability [LIST-STATUS] is also available, | When the LIST-STATUS IMAP capability [LIST-STATUS] is also available, | |||
| the STATUS command can be combined with the LIST command to further | the STATUS command can be combined with the LIST command to further | |||
| improve efficiency. This way, the sizes of many mailboxes can be | improve efficiency. This way, the sizes of many mailboxes can be | |||
| queried with just one LIST command. | queried with just one LIST command. | |||
| Example: | Example: | |||
| C: A04 LIST "" % RETURN (STATUS (MESSAGES SIZE)) | C: A04 LIST "" % RETURN (STATUS (MESSAGES SIZE)) | |||
| S: * LIST () "." "INBOX" | S: * LIST () "." "INBOX" | |||
| S: * STATUS "INBOX" (MESSAGES 17 SIZE 16234) | S: * STATUS "INBOX" (MESSAGES 17 SIZE 16234) | |||
| S: * LIST () "." "frop" | S: * LIST () "." "frop" | |||
| S: * STATUS "frop" (MESSAGES 8 SIZE 44421) | S: * STATUS "frop" (MESSAGES 8 SIZE 44421) | |||
| S: A04 OK List completed. | S: A04 OK List completed. | |||
| 4. Formal Syntax | 4. Formal Syntax | |||
| The following syntax specification augments the grammar specified in | The following syntax specification augments the grammar specified in | |||
| [IMAP4rev1]. It uses the Augmented Backus-Naur Form (ABNF) notation | [IMAP4rev1]. It uses the Augmented Backus-Naur Form (ABNF) notation | |||
| as specified in [ABNF]. Elements not defined here are taken from | as specified in [ABNF]. Elements not defined here are taken from | |||
| [IMAP4rev1]. | [IMAP4rev1]. | |||
| capability =/ "STATUS=SIZE" | capability =/ "STATUS=SIZE" | |||
| status-att =/ "SIZE" | status-att =/ "SIZE" | |||
| [FIXME: Interaction with 64BIT capability] | ||||
| 5. Security Considerations | 5. Security Considerations | |||
| There are no known additional security issues with this extension | There are no known additional security issues with this extension | |||
| beyond those described for the base protocol [IMAP4rev1] and for the | beyond those described for the base protocol [IMAP4rev1] and for the | |||
| LIST-STATUS extension [LIST-STATUS]. | LIST-STATUS extension [LIST-STATUS]. | |||
| 6. IANA Considerations | 6. IANA Considerations | |||
| The IANA is requested to add "STATUS=SIZE" to the "IMAP Capabilities" | The IANA is requested to add "STATUS=SIZE" to the "IMAP Capabilities" | |||
| registry located at <http://www.iana.org/assignments/imap- | registry located at <http://www.iana.org/assignments/imap- | |||
| End of changes. 6 change blocks. | ||||
| 10 lines changed or deleted | 13 lines changed or added | |||
This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/ | ||||