| Internet-Draft | IMAP UIDONLY | March 2024 |
| Melnikov, et al. | Expires 19 September 2024 | [Page] |
The UIDONLY extension to the Internet Message Access Protocol (RFC 3501/RFC 9051) allows clients to enable a mode in which information about mailbox changes is returned using only Unique Identifiers (UIDs). Message numbers are not returned in responses, and can't be used in requests once this extension is enabled. This helps both clients and servers to reduce resource usage required to maintain a map between message numbers and UIDs.¶
This document defines an experimental IMAP extension.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 19 September 2024.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document may contain material from IETF Documents or IETF Contributions published or made publicly available before November 10, 2008. The person(s) controlling the copyright in some of this material may not have granted the IETF Trust the right to allow modifications of such material outside the IETF Standards Process. Without obtaining an adequate license from the person(s) controlling the copyright in such materials, this document may not be modified outside the IETF Standards Process, and derivative works of it may not be created outside the IETF Standards Process, except to format it for publication as an RFC or to translate it into languages other than English.¶
This document defines an extension to the Internet Message Access Protocol [RFC3501] for eliminating use of message numbers. This extension is compatible with both IMAP4rev1 [RFC3501] and IMAP4rev2 [RFC9051].¶
The UIDONLY extension of the Internet Message Access Protocol (RFC 3501/RFC 9051) allows clients to request that servers only use and return UIDs. This helps both clients and servers to reduce resource usage required for maintenance of message number to UID map.¶
In protocol examples, this document uses a prefix of "C: " to denote lines sent by the client to the server, and "S: " for lines sent by the server to the client. Lines prefixed with "// " are comments explaining the previous protocol line. These prefixes and comments are not part of the protocol. Lines without any of these prefixes are continuations of the previous line, and no line break is present in the protocol unless specifically mentioned.¶
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.¶
Other capitalised words are names of IMAP commands or responses [RFC3501][RFC9051] or keywords from this document.¶
An IMAP server advertises support for the UIDONLY extension by including the "UIDONLY" capability in the CAPABILITY response/response code.¶
Once the UIDONLY extension is enabled (see Section 3.1), the client MUST NOT use message sequence numbers (including the special marker "*") in any arguments to IMAP commands, and the server MUST return a tagged BAD response if the client uses message sequence numbers. The server MUST include the UIDREQUIRED response code in such BAD responses (see below). Additionally, once the UIDONLY extension is enabled, the server MUST NOT return message sequence numbers in any response.¶
The UIDREQUIRED response code is defined as follows:¶
The UIDONLY extension affects how information about new, expunged or changed messages is returned in unsolicited responses. In partucular, it affects responses to UID FETCH/UID STORE/EXPUNGE/UID EXPUNGE, as well as how unsolicited mailbox changes are announced.¶
The following subsections describe changes introduced by this extension in more detail.¶
As the UIDONLY extension affects how information about new, expunged or changed messages is returned in unsolicited responses, it has to be enabled by the client first using the ENABLE command.¶
S: * OK [CAPABILITY IMAP4rev1 ENABLE CONDSTORE QRESYNC UIDONLY
AUTH=SCRAM-SHA-256]
C: 01 ENABLE UIDONLY
S: * ENABLED UIDONLY
S: 01 OK ENABLE completed
¶
When UIDONLY is enabled, FETCH, STORE, SEARCH, COPY and MOVE commands are prohibited and MUST result in a tagged BAD response. Clients should instead use UID FETCH, UID STORE, UID SEARCH, UID COPY or UID MOVE respectively.¶
When UIDONLY is enabled, all FETCH responses that would be returned by UID FETCH/UID STORE are replaced by UIDFETCH responses.¶
Note that UIDFETCH response contains the same response data items as specified for the FETCH response. The UID is always returned at the beginning of a UIDFETCH response, and it can also appear in the UID response data item, if requested by the client. While the UID response data item is redundant when requested, it can simplify updating of existing (non UIDONLY) implementations to support UIDONLY.¶
C: 10 UID FETCH 25900:26600 (FLAGS) [...] S: * 25996 UIDFETCH (FLAGS (\Seen)) S: * 25997 UIDFETCH (FLAGS (\Flagged \Answered)) S: * 26600 UIDFETCH (FLAGS ()) S: 10 OK FETCH completed¶
C: 11 UID FETCH 25900:26600 (UID FLAGS) S: * 25900 UIDFETCH (FLAGS (\Seen) UID 25900) S: * 25902 UIDFETCH (FLAGS (\Flagged) UID 25902) S: * 26310 UIDFETCH (FLAGS (\Answered) UID 26310) S: * 26311 UIDFETCH (FLAGS () UID 26311) S: * 26498 UIDFETCH (FLAGS (\Answered) UID 26498) [...] S: 11 OK FETCH completed¶
When UIDONLY is enabled, all EXPUNGED responses that would be returned by EXPUNGE/UID EXPUNGE are replaced by VANISHED responses, as defined in [RFC7162]. Note that a server that implements UIDONLY extension is not required (but allowed) to also implement CONDSTORE and/or QRESYNC extensions.¶
C: 12 EXPUNGE S: * VANISHED 405,407,410,425 S: 12 OK expunged¶
The "<sequence set>" UID SEARCH criterion is prohibited (and results in a tagged BAD response) once UIDONLY is enabled. Clients should use ALL or "UID <sequence set>" UID SEARCH criterion instead.¶
When UIDONLY is enabled, all changes to flags (and other dynamic message attributes) are returned using UIDFETCH responses, instead of FETCH responses.¶
Similarly, all expunged messages are announced using VANISHED responses instead of EXPUNGE responses.¶
This extension doesn't affect EXISTS or RECENT responses.¶
UID MOVE/UID COPY commands SHOULD return the COPYUID response code, as specified in [RFC4315].¶
Use of the UIDNOTSTICKY response code (see [RFC4315]) is not compatible with the UIDONLY extension, i.e. a server that advertises the UIDONLY extension MUST NOT return UIDNOTSTICKY response code.¶
C: 15 UID move 597 "Archives/2023/2023-05" S: * OK [COPYUID 1685977201 597 2] UID MOVE S: * VANISHED 597 S: 15 OK UID MOVE Completed¶
The CONDSTORE extension is compatible with the UIDONLY extension. The MODSEQ message data item is returned in UIDFETCH responses instead of FETCH responses.¶
The QRESYNC extension is compatible with the UIDONLY extension, but once UIDONLY is enabled, the fourth SELECT QRESYNC parameter ("Message Sequence Match Data", see Section 3.2.5.2 of [RFC7162]) MUST NOT be used. The server MUST return a tagged BAD response if such a parameter is observed once UIDONLY is enabled.¶
IMAP extensions might define other commands that accept message sequence numbers ("sequence-set" ABNF non terminal, see Section 9 of [RFC9051]). Once UIDONLY is enabled, the server MUST reject such commands with tagged BAD response. For example, SORT and THREAD [RFC5256] commands are prohibited, similarly to the SEARCH command. However UID SORT and UID THREAD can be used instead.¶
The following syntax specification uses the Augmented Backus-Naur Form (ABNF) notation as specified in [ABNF].¶
Non-terminals referenced but not defined below are as defined by Section 9 of IMAP4 [RFC9051].¶
Except as noted otherwise, all alphabetic characters are case-insensitive. The use of upper or lower case characters to define token strings is for editorial clarity only. Implementations MUST accept these strings in a case-insensitive fashion.¶
SP = <Defined in RFC 5234>
capability =/ "UIDONLY"
;; <capability> from [RFC9051]
message-data =/ uidfetch-resp
uidfetch-resp = uniqueid SP "UIDFETCH" SP msg-att
;; The uniqueid is the UID of
;; the corresponding message
message-data =/ expunged-resp
expunged-resp = <defines VANISHED response, see RFC 7162>
resp-text-code =/ "UIDREQUIRED"
¶
This IMAP extension is not believed to add any additional Security Considerations beyond the ones that are generally applicable to IMAP4rev1 [RFC3501] and IMAP4rev2 [RFC9051].¶
IMAP4 capabilities are registered by publishing a standards track or IESG approved Informational or Experimental RFC. The registry is currently located at:¶
https://www.iana.org/assignments/imap4-capabilities¶
IANA is requested to add definition of the UIDONLY extension to this registry with [RFCXXXX] as the reference.¶
IANA is also requested to add definition of the UIDREQUIRED response code to the "IMAP Response Codes" registry with [RFCXXXX] as the reference. The registry is currently located at:¶
https://www.iana.org/assignments/imap-response-codes/imap-response-codes.xhtml¶
An earlier draft of this document proposed use of FETCH responses with the message number parameter always be set to 0. This was judged to be too risky, as this could have caused unexpected side effects and cache corruptions in client code that was not properly updated to handle lack of message numbers.¶
Editors of this document would like to thank the following people who provided useful comments and/or participated in discussions that lead to this document, in particular: Arnt Gulbrandsen, Ken Murchison Bron Gondwana and Elwyn Davis. This document is similar to draft-gulbrandsen-imap-uidonly-00.txt, but some different syntactic choices were made in the end.¶