draft-ietf-imapext-annotate-16.txt   rfc5257.txt 
IMAP Extensions Working Group C. Daboo Network Working Group C. Daboo
Internet-Draft Apple Computer Request for Comments: 5257 Apple Inc.
Intended status: Informational R. Gellens Category: Experimental R. Gellens
Expires: February 2, 2007 QUALCOMM Incorporated QUALCOMM Incorporated
August 2006 June 2008
IMAP ANNOTATE Extension
draft-ietf-imapext-annotate-16
Status of this Memo
By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet-
Drafts.
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."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html.
This Internet-Draft will expire on February 2, 2007. Internet Message Access Protocol - ANNOTATE Extension
Copyright Notice Status of This Memo
Copyright (C) The Internet Society (2006). This memo defines an Experimental Protocol for the Internet
community. It does not specify an Internet standard of any kind.
Discussion and suggestions for improvement are requested.
Distribution of this memo is unlimited.
Abstract Abstract
The ANNOTATE extension to the Internet Message Access Protocol The ANNOTATE extension to the Internet Message Access Protocol
permits clients and servers to maintain "meta data" for messages, or permits clients and servers to maintain "meta data" for messages, or
individual message parts, stored in a mailbox on the server. For individual message parts, stored in a mailbox on the server. For
example, this can be used to attach comments and other useful example, this can be used to attach comments and other useful
information to a message. It is also possible to attach annotations information to a message. It is also possible to attach annotations
to specific parts of a message, so that, for example, they could be to specific parts of a message, so that, for example, they could be
marked as seen or important, or a comment added. marked as seen, or important, or a comment added.
Change History (to be removed prior to publication as an RFC)
Changes from -15 to -16:
1. Updated to rfc 4551 reference.
2. Updated to rfc 4466 reference.
3. Reworded first sentence of 4.2.
4. Added proper description of body part flag meaning.
5. Added text about 0 for size and NIL for value of non-existent
entries.
6. Added note about CONDSTORE behavior in 5.5.
7. Reworded first sentence of 5.1 for consistency with base spec
elements.
8. Various spelling fixes.
Changes from -14 to -15:
1. Updated to rfc 4314 reference.
2. Removed Content-Language value and reference.
3. Added statement about experimental status.
4. Changed to experimental capability name.
5. Removed ability to sort on size attribute.
6. Expanded abstract.
Changes from -13 to -14:
1. Changed 'string' formal syntax to 'list-mailbox' and 'astring'
for entry/attribute names.
2. Updated examples to match new astring syntax.
3. Now requires explicit use of .priv or .shared in SORT.
4. Removed requirement that 'n' right only be present if 'r' right
is also present.
5. Changed ANNOTATESIZE response to ANNOTATIONS response.
6. Allow servers to indicate that they do not support private
annotations.
7. Added example for extended SELECT including ANNOTATIONS response
code.
8. Removed content-type attribute.
9. Removed display-name attribute.
10. Prevent use of * and % wildcards in attributes.
11. Only allow "value" attributes in SEARCH.
12. Only allow "value" or "size" attributes in SORT.
13. Removed vendor attributes.
14. Removed IMAP flags, though the /flags entry path is reserved.
15. Added internationalization considerations.
Changes from -12 to -13:
1. Sync with change from DC meeting wrt 'r' right for both read and
write of .priv.
2. Add text about 'n' right being a 'shared flag right' as defined
in 2086upd.
3. Allow NIL in /<section-part>/flags entries.
4. Expand abstract to also indicate that annotations can apply on a
per-body part basis as well as per message.
5. Fix resp-text-code to use nil instead of "NIL".
6. Use double-quotes consistently around ANNOTATESIZE etc.
7. Fix typos.
8. Remove redundant second para of Introduction.
9. Added 'Conventions' section with RFC2119 reference..
10. Describe S:, C: example behavior in conventions section..
11. Clarify that new rights must also be present if only old ACL is
present.
12. Entry/attributes MUST NOT contain consecutive or trailing '/' or
'.'.
13. Clarify default charset for content-type text/plain.
14. Recommend use of utf-8 for all non-ascii text.
15. Clarify terminology of ANNOTATESIZE response code.
16. Require servers to return ANNOTATESIZE on SELECT.
17. Change an example to use UID FETCH for variety.
18. Clarify what to do about annotations exceeding allowed
ANNOTATESIZE when doing copy.
19. Use ABNFext document for extended SELECT etc.
20. Remove RFC1891 reference.
21. capability syntax extension.
22. Comment on validation content-type attribute.
23. Added recommended content-type in IANA registration.
24. Added use of literal8 for values.
25. Prevent use of 'shared' and 'priv' as separate hierarchy
components.
26. Restrict entry/attribute names to ascii and added display-name
attribute.
27. Remove references to CATENATE and use ABNFext for extended
APPEND syntax.
Changes from -11 to -12:
1. Fixed raw XML in formal syntax.
2. Fixed double \ in IANA section titles.
3. Fixed APPEND formal syntax.
4. Added annotations to CATENATE extension.
5. Reworded text for unsolicited responses.
6. Fixed formal syntax for fetch responses to extend base spec item.
Changes from -10 to -11:
1. Flags are now read-only and exactly match their IMAP
counterparts.
2. Added new ACL bits for annotations.
3. Revise security considerations.
4. Fixed some references.
Changes from -09 to -10:
1. Added Content-Language value.
2. Added IANA registrations for entries/attributes in this document.
Changes from -08 to -09:
1. Fix formatting, ID nits etc.
2. Fix subject -> altsubject in examples.
3. Added text to SELECT/EXAMINE optional parameter definition to
indicate that the option could trigger a global state change or a
mailbox specific change.
4. Changed entry/attribute names to be case-sensitive to avoid case
mapping issues with utf8 text.
5. Clarify COPY interaction to indicate that only the current user's
'.priv's are copied, not the '.priv's of other users.
Changes from -07 to -08: Note that this document was the product of a WG that had good
1. ANNOTATESIZE response changed to use "NIL" for a mailbox that consensus on how to approach the problem. Nevertheless, the WG felt
does not support any type of annotations, and "0" for a mailbox it did not have enough information on implementation and deployment
that only supports read-only annotations. hurdles to meet all of the requirements of a Proposed Standard. The
IETF solicits implementations and implementation reports in order to
make further progress.
Changes from -06 to -07: Implementers should be aware that this specification may change in an
1. Added text to state entry and attribute names are always case- incompatible manner when going to Proposed Standard status. However,
insensitive. any incompatible changes will result in a new capability name being
2. Removed top-level entry namespace. used to prevent problems with any deployments of the experimental
3. Added server accept minima for annotation size and count. extension.
4. Added [ANNOTATE TOOBIG] & [ANNOTATE TOOMANY] response codes.
5. Added [ANNOTATESIZE <<n>>] response code.
6. Added comment on suggested CONDSTORE support.
7. Modified append behavior to account for MULTIAPPEND.
8. Tweaked ABNF.
Changes from -05 to -06: Table of Contents
1. Split references into Normative and Informative.
2. Reworked flags to allow IMAP4 flag prefix to appear in annotation
name.
3. Removed smtp-envelope annotation - a future extension can add
this.
4. Changed subject to altsubject.
5. Added $MDNSent flag and reference to document.
6. Cleaned up formal syntax to use IMAP string type for entry and
attributes, with requirements on how the string is formatted.
7. Use of ACAP vendor subtree registry for vendor tokens.
8. Fixed STORE syntax. 1. Introduction and Overview .......................................3
2. Conventions Used in This Document ...............................4
3. Data Model ......................................................4
3.1. Overview ...................................................4
3.2. Namespace of Entries and Attributes ........................4
3.2.1. Entry Names .........................................5
3.2.2. Attribute Names .....................................7
3.3. Private Versus Shared ......................................7
3.4. Access Control .............................................8
3.5. Access to Standard IMAP Flags and Keywords ................11
4. IMAP Protocol Changes ..........................................11
4.1. General Considerations ....................................11
4.2. ANNOTATE Parameter with the SELECT/EXAMINE Commands .......12
4.3. ANNOTATION Message Data Item in FETCH Command .............12
4.4. ANNOTATION Message Data Item in FETCH Response ............14
4.5. ANNOTATION Message Data Item in STORE .....................16
4.6. ANNOTATION Interaction with COPY ..........................18
4.7. ANNOTATION Message Data Item in APPEND ....................18
4.8. ANNOTATION Criterion in SEARCH ............................19
4.9. ANNOTATION Key in SORT ....................................20
4.10. New ACL Rights ...........................................21
5. Formal Syntax ..................................................21
6. IANA Considerations ............................................23
6.1. Entry and Attribute Registration Template .................23
6.2. Entry Registrations .......................................24
6.2.1. /comment ...........................................24
6.2.2. /flags .............................................24
6.2.3. /altsubject ........................................25
6.2.4. /<section-part>/comment ............................25
6.2.5. /<section-part>/flags/seen .........................26
6.2.6. /<section-part>/flags/answered .....................26
6.2.7. /<section-part>/flags/flagged ......................27
6.2.8. /<section-part>/flags/forwarded ....................27
6.3. Attribute Registrations ...................................28
6.3.1. value ..............................................28
6.3.2. size ...............................................28
7. Internationalization Considerations ............................28
8. Security Considerations ........................................29
9. References .....................................................29
9.1. Normative References ......................................29
9.2. Informative References ....................................30
10. Acknowledgments ...............................................30
Changes from -04 to -05: 1. Introduction and Overview
1. Fixed examples to match formal syntax for FETCH responses where
parenthesis do not appear around entry-att items.
Changes from -03 to -04: The ANNOTATE extension is present in any IMAP [RFC3501]
1. Fixed attrib/attrib-match grammar to use "." instead of "/". implementation that returns "ANNOTATE-EXPERIMENT-1" as one of the
2. Add text for server to reject unknown <part-specifier>. supported capabilities in the CAPABILITY response.
3. Do not allow empty part-specifier.
4. Store NIL to value to delete.
5. Comment on COPY interaction with ANNOTATE.
6. Added comment that IMAP flags are mapped one-to-one with their
corresponding FLAGS items.
7. Added comment that the recent flag annotation is read-only.
Changes from -02 to -03: This extension makes the following changes to the IMAP protocol:
1. Removed reference to status modtime item.
2. Added missing 'notify' and 'ret' dsn annotations for /message/
smtp-envelope.
3. Added requirement to store data permanently - no 'session only'
annotations.
4. Removed Access Control section. Replaced with comments on read-
only/read-write mailboxes and storing private or shared
annotations.
5. Removed STORE to default .priv or .shared.
6. Added section on optional select parameters.
Changes from -01 to -02: a. adds a new ANNOTATION message data item for use in FETCH.
1. Now require .priv or .shared on store operations.
Changes from -00 to -01: b. adds a new ANNOTATION message data item for use in STORE.
1. MODTIME moved to its own draft, which this draft now depends on.
Thus, Conditional Annotation STORE and related items deleted from
this draft.
2. Private versus Shared Annotations: both are possible (separately
addressable using ".priv" and ".shared" suffixes). There is a
per-mailbox setting for the default. It is an open issue how
this is viewed or changed by the client.
3. In ACLs, the "w" right is needed to updated shared state; the "s"
right is needed to update private state.
4. Various clarifications and text modifications.
5. Added 'forwarded' flag for message parts.
Changes from pre-imapext to -00: c. adds a new ANNOTATION search criterion for use in SEARCH.
1. Clarified text describing attributions, entries, and attributes.
2. Changed 'modifiedsince' to 'modtime'; referenced ACAP spec. d. adds a new ANNOTATION sort key for use in the SORT extension.
3. Deleted 'queued' flag.
4. Expanded and explained smtp-envelope entry.
5. Restricted including ANNOTATION data in unsolicited responses
until the client uses it first. (Open issue as to if needed).
6. Examples now only use valid entries and attributes.
7. Updated Security Considerations.
8. Content-Type now defaults to text/plain.
9. Open Issue: Shared vs. private annotations.
10. Open issue: Annotation Modtime untagged response or VALIDTIME
FETCH data.
11. Open issue: Conditional annotation STORE.
12. ANNOTATION criterion available if both "ANNOTATE" and "SORT" in
CAPABILITY command response.
13. Prohibition on annotations in lieu of base spec functionality.
14. Specified required ACL rights.
15. ANNOTATION message data item in APPEND.
16. ANNOTATION-MODTIME message data item in STATUS.
17. Replaced ATOM_CHAR with utf8-char.
18. Updated other ABNF entries.
Table of Contents e. adds a new ANNOTATION data item for use in APPEND.
1. Introduction and Overview . . . . . . . . . . . . . . . . . . 8 f. adds a new requirement on the COPY command.
2. Working Group Note on Status . . . . . . . . . . . . . . . . . 8
3. Conventions Used in This Document . . . . . . . . . . . . . . 9
4. Data Model . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2. Namespace of entries and attributes . . . . . . . . . . . 9
4.2.1. Entry Names . . . . . . . . . . . . . . . . . . . . . 10
4.2.2. Attribute Names . . . . . . . . . . . . . . . . . . . 12
4.3. Private versus Shared . . . . . . . . . . . . . . . . . . 12
4.4. Access Control . . . . . . . . . . . . . . . . . . . . . . 13
4.5. Access to Standard IMAP Flags and Keywords . . . . . . . . 16
5. IMAP Protocol Changes . . . . . . . . . . . . . . . . . . . . 16
5.1. General Considerations . . . . . . . . . . . . . . . . . . 16
5.2. ANNOTATE parameter with the SELECT/EXAMINE commands . . . 17
5.3. ANNOTATION Message Data Item in FETCH Command . . . . . . 17
5.4. ANNOTATION Message Data Item in FETCH Response . . . . . . 19
5.5. ANNOTATION Message Data Item in STORE . . . . . . . . . . 21
5.6. ANNOTATION interaction with COPY . . . . . . . . . . . . . 22
5.7. ANNOTATION Message Data Item in APPEND . . . . . . . . . . 23
5.8. ANNOTATION Criterion in SEARCH . . . . . . . . . . . . . . 23
5.9. ANNOTATION Key in SORT . . . . . . . . . . . . . . . . . . 24
5.10. New ACL Rights . . . . . . . . . . . . . . . . . . . . . . 25
6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 25
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 27
7.1. Entry and Attribute Registration Template . . . . . . . . 27
7.2. Entry Registrations . . . . . . . . . . . . . . . . . . . 28
7.2.1. /comment . . . . . . . . . . . . . . . . . . . . . . . 28
7.2.2. /flags . . . . . . . . . . . . . . . . . . . . . . . . 28
7.2.3. /altsubject . . . . . . . . . . . . . . . . . . . . . 29
7.2.4. /<section-part>/comment . . . . . . . . . . . . . . . 29
7.2.5. /<section-part>/flags/seen . . . . . . . . . . . . . . 30
7.2.6. /<section-part>/flags/answered . . . . . . . . . . . . 30
7.2.7. /<section-part>/flags/flagged . . . . . . . . . . . . 31
7.2.8. /<section-part>/flags/forwarded . . . . . . . . . . . 31
7.3. Attribute Registrations . . . . . . . . . . . . . . . . . 31
7.3.1. value . . . . . . . . . . . . . . . . . . . . . . . . 32
7.3.2. size . . . . . . . . . . . . . . . . . . . . . . . . . 32
8. Internationalization Considerations . . . . . . . . . . . . . 32
9. Security Considerations . . . . . . . . . . . . . . . . . . . 32
10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 33
10.1. Normative References . . . . . . . . . . . . . . . . . . . 33
10.2. Informative References . . . . . . . . . . . . . . . . . . 33
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . . 34
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 34
Intellectual Property and Copyright Statements . . . . . . . . . . 35
1. Introduction and Overview g. adds a new ANNOTATE parameter for use with the SELECT/EXAMINE
commands.
The ANNOTATE extension is present in any IMAP [RFC3501] h. adds two new response codes to indicate store failures of
implementation which returns "ANNOTATE-EXPERIMENT-1" as one of the annotations.
supported capabilities in the CAPABILITY response.
This extension makes the following changes to the IMAP protocol: i. adds a new untagged response code for the SELECT or EXAMINE
commands to indicate the maximum sized annotation that can be
stored.
a. adds a new ANNOTATION message data item for use in FETCH j. adds a new Access Control List (ACL) "bit" for use with the ACL
b. adds a new ANNOTATION message data item for use in STORE extensions [RFC2086] and [RFC4314].
c. adds a new ANNOTATION search criterion for use in SEARCH
d. adds a new ANNOTATION sort key for use in SORT extension
e. adds a new ANNOTATION data item for use in APPEND
f. adds a new requirement on the COPY command
g. adds a new ANNOTATE parameter for use with the SELECT/EXAMINE
commands
h. adds two new response codes to indicate store failures of
annotations.
i. adds a new untagged response code for the SELECT or EXAMINE
commands to indicate the maximum size.
j. adds a new ACL "bit" for use with the ACL extensions [RFC2086]
and [RFC4314] .
The data model used for the storage of annotations is based on that The data model used for the storage of annotations is based on the
of the Application Configuration Access Protocol [RFC2244]. Note Application Configuration Access Protocol [RFC2244]. Note that there
that there is no inheritance in annotations. is no inheritance in annotations.
If a server supports annotations, then it MUST store all annotation If a server supports annotations, then it MUST store all annotation
data permanently, i.e. there is no concept of "session only" data permanently, i.e., there is no concept of "session only"
annotations that would correspond to the behavior of "session" flags annotations that would correspond to the behavior of "session" flags
as defined in the IMAP base specification. as defined in the IMAP base specification.
In order to provide optimum support for a disconnected client (one In order to provide optimum support for a disconnected client (one
that needs to synchronize annotations for use when offline), servers that needs to synchronize annotations for use when offline), servers
SHOULD also support the Conditional STORE [RFC4551] extension. SHOULD also support the Conditional STORE [RFC4551] extension.
The rest of this document describes the data model and protocol The rest of this document describes the data model and protocol
changes more rigorously. changes more rigorously.
2. Working Group Note on Status 2. Conventions Used in This Document
The IMAP Extensions Working Group, which produced this specification,
has felt it important to first gain implementation experience with
this specification before submitting it as a 'proposed standard' for
more general deployment, and therefore suggests that it be published
as Experimental. As such the Working Group strongly encourages
implementers to implement this specification as-is and provide their
valuable feedback on any problems or issues found when doing that or
when attempting to interoperate with other products.
Implementers should be aware that this specification may change in an
incompatible manner when going to 'proposed standard' status.
However, any incompatible changes will result in a new capability
name being used to prevent problems with any deployments of the
experimental extension.
3. Conventions Used in This Document
In examples, "C:" and "S:" indicate lines sent by the client and The examples in this document use "C:" and "S:" to indicate lines
server respectively. sent by the client and server, respectively.
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 [RFC2119]. document are to be interpreted as described in [RFC2119].
4. Data Model 3. Data Model
4.1. Overview 3.1. Overview
The data model used in ANNOTATE is that of a uniquely named entry The data model for annotations in ANNOTATE uses a uniquely named
which contains a set of standard attributes. A single coherent unit entry that contains a set of standard attributes. Thus, a single
of "meta data" for a message is stored as a single entry, made up of coherent unit of "meta data" for a message is stored as a single
several attributes. entry, made up of several attributes.
For example, a comment annotation added to a message has an entry For example, a comment annotation added to a message has an entry
name of "/comment". This entry is composed of several attributes name of "/comment". This entry is composed of several attributes
such as "value", "size", etc. which contain the properties and data such as "value", "size", etc., that contain the properties and data
of the entry. of the entry.
The protocol changes to IMAP described below allow a client to access The protocol changes to IMAP, described below, allow a client to
or change the values of any attributes in any entries in a message access or change the values of any attribute in any entry in a
annotation, assuming it has sufficient access rights to do so (see message annotation, assuming it has sufficient access rights to do so
Section 4.4 for specifics). (see Section 3.4 for specifics).
4.2. Namespace of entries and attributes 3.2. Namespace of Entries and Attributes
A message may contain zero or more annotations, each of which is a A message may contain zero or more annotations, each of which is a
single uniquely named entry. Each entry has a hierarchical name, single uniquely named entry. Each entry has a hierarchical name,
with each component of the name separated by a slash ("/"). An entry with each component of the name separated by a slash ("/"). An entry
name MUST NOT contain two consecutive "/" characters and MUST NOT end name MUST NOT contain two consecutive "/" characters and MUST NOT end
with a "/" character. with a "/" character.
Each entry is made up of a set of attributes. Each attribute has a Each entry is made up of a set of attributes. Each attribute has a
hierarchical name, with each component of the name separated by a hierarchical name, with each component of the name separated by a
period ("."). An attribute name MUST NOT contain two consecutive "." period ("."). An attribute name MUST NOT contain two consecutive "."
characters and MUST NOT end with a "." character. characters and MUST NOT end with a "." character.
The value of an attribute is "NIL" (has no value), or is a string of The value of an attribute is "NIL" (has no value), or is a string of
zero or more octets. zero or more octets.
Entry and attribute names MUST NOT contain asterisk ("*") or percent Entry and attribute names MUST NOT contain asterisk ("*") or percent
("%") characters and MUST NOT contain non-ASCII characters or the ("%") characters, and MUST NOT contain non-ASCII characters or the
NULL octet. Invalid entry or attribute names result in a BAD NULL octet. Invalid entry or attribute names result in a BAD
response in any IMAP commands where they are used. response in any IMAP commands where they are used.
Attribute names MUST NOT contain any hierarchical components with the Attribute names MUST NOT contain any hierarchical components with the
names "priv" or "shared" as those have special meaning (see names "priv" or "shared", as those have special meaning (see Section
Section 4.3). 3.3).
Entry and attribute names are case-sensitive. Entry and attribute names are case-sensitive.
Use of control or punctuation characters in entry and attribute names Use of control or punctuation characters in entry and attribute names
is strongly discouraged. is strongly discouraged.
This specification defines an initial set of entry and attribute This specification defines an initial set of entry and attribute
names available for use in message annotations. In addition, an names available for use in message annotations. In addition, an
extension mechanism is described to allow additional names to be extension mechanism is described to allow additional names to be
added as needed. added as needed.
4.2.1. Entry Names 3.2.1. Entry Names
Entry names MUST be specified in a standards track or IESG approved Entry names MUST be specified in a standards track or IESG approved
experimental RFC, or fall under the vendor namespace. See experimental RFC, or fall under the vendor namespace. See Section
Section 7.1 for the registration template. 6.1 for the registration template.
/ /
Defines the top-level of entries associated with an entire Defines the top-level of entries associated with an entire
message. This entry itself does not contain any attributes. All message. This entry itself does not contain any attributes. All
entries that start with a numeric character ("0" - "9") refer to entries that start with a numeric character ("0" - "9") refer to
an annotation on a specific body part. All other entries are for an annotation on a specific body part. All other entries are for
annotations on the entire message. annotations on the entire message.
/comment /comment
Defines a comment or note associated with an entire message. Defines a comment or note associated with an entire message.
/flags /flags
This entry hierarchy is reserved for future use. This entry hierarchy is reserved for future use.
/altsubject /altsubject
Contains text supplied by the message recipient, to be used by the Contains text supplied by the message recipient to be used by the
client instead of the original message Subject. client, instead of the original message Subject.
/vendor/<vendor-token> /vendor/<vendor-token>
Defines the top-level of entries associated with an entire message Defines the top-level of entries associated with an entire message
as created by a particular product of some vendor. These sub- as created by a particular product of some vendor. These sub-
entries can be used by vendors to provide client-specific entries can be used by vendors to provide client-specific
annotations. The vendor-token MUST be registered with IANA, using annotations. The vendor-token MUST be registered with IANA, using
the [RFC2244] vendor subtree registry. the [RFC2244] vendor subtree registry.
/<section-part> /<section-part>
Defines the top-level of entries associated with a specific body Defines the top-level of entries associated with a specific body
skipping to change at page 11, line 30 skipping to change at page 6, line 16
uses an incorrect part specifier (either incorrect syntax or a uses an incorrect part specifier (either incorrect syntax or a
specifier referring to a non-existent part). The server MUST specifier referring to a non-existent part). The server MUST
return a BAD response if the client uses an empty part specifier return a BAD response if the client uses an empty part specifier
(which is used in IMAP to represent the entire message). (which is used in IMAP to represent the entire message).
/<section-part>/comment /<section-part>/comment
Defines a comment or note associated with a specific body part of Defines a comment or note associated with a specific body part of
a message. a message.
/<section-part>/flags /<section-part>/flags
Defines the top-level of entries associated with flag state for a Defines the top-level of entries associated with the flag state
specific body part of a message. All sub-entries are maintained for a specific body part of a message. All sub-entries are
entirely by the client. There is no implicit change to any flag maintained entirely by the client. There is no implicit change to
by the server. any flag by the server.
/<section-part>/flags/seen /<section-part>/flags/seen
This is similar to the IMAP \Seen flag except it applies to This is similar to the IMAP \Seen flag, except it applies
only the body part referenced by the entry. to only the body part referenced by the entry.
/<section-part>/flags/answered
This is similar to the IMAP \Answered flag except it applies /<section-part>/flags/answered
to only the body part referenced by the entry. This is similar to the IMAP \Answered flag, except it
/<section-part>/flags/flagged applies to only the body part referenced by the entry.
This is similar to the IMAP \Flagged flag except it applies
to only the body part referenced by the entry. /<section-part>/flags/flagged
/<section-part>/flags/forwarded This is similar to the IMAP \Flagged flag, except it
This is similar to the IMAP $Forwarded keyword except it applies to only the body part referenced by the entry.
applies to only the body part referenced by the entry.
/<section-part>/flags/forwarded
This is similar to the IMAP $Forwarded keyword, except it
applies to only the body part referenced by the entry.
Defines flags for a specific body part of a message. The "value" Defines flags for a specific body part of a message. The "value"
attribute of each of the entries described above must be either attribute of each of the entries described above must be either
"1", "0" or "NIL". "1" corresponds to the flag being set. "1", "0", or "NIL". "1" corresponds to the flag being set.
/<section-part>/vendor/<vendor-token> /<section-part>/vendor/<vendor-token>
Defines the top-level of entries associated with a specific body Defines the top-level of entries associated with a specific body
part of a message as created by a particular product of some part of a message as created by a particular product of some
vendor. This entry can be used by vendors to provide client vendor. This entry can be used by vendors to provide client
specific annotations. The vendor-token MUST be registered with specific annotations. The vendor-token MUST be registered with
IANA. IANA.
4.2.2. Attribute Names 3.2.2. Attribute Names
Attribute names MUST be specified in a standards track or IESG Attribute names MUST be specified in a standards track or IESG
approved experimental RFC. See Section 7.1 for the registration approved experimental RFC. See Section 6.1 for the registration
template. template.
All attribute names implicitly have a ".priv" and a ".shared" suffix All attribute names implicitly have a ".priv" and a ".shared" suffix
which maps to private and shared versions of the entry. Searching or that maps to private and shared versions of the entry. Searching or
fetching without using either suffix includes both. The client MUST fetching without using either suffix will include both. The client
specify either a ".priv" or ".shared" suffix when storing an MUST specify either a ".priv" or ".shared" suffix when storing an
annotation or sorting on annotations. annotation or sorting on annotations.
value value
A string or binary data representing the value of the annotation. A string or binary data representing the value of the annotation.
To delete an annotation, the client can store "NIL" into the To delete an annotation, the client can store "NIL" into the
value. If the client requests the value attribute for a non- value. If the client requests the value attribute for a non-
existent entry, then the server MUST return "NIL" for the value. existent entry, then the server MUST return "NIL" for the value.
The content represented by the string is determined by the The content represented by the string is determined by the
content-type used to register the entry (see Section 7.1 for entry content-type used to register the entry (see Section 6.1 for entry
registration templates). Where applicable, the registered registration templates). Where applicable, the registered
content-type MUST include a charset parameter. Text values SHOULD content-type MUST include a charset parameter. Text values SHOULD
use the utf-8 [RFC3629] character set. use the utf-8 [RFC3629] character set. Note that binary data
Note that binary data (data which may contain the NULL octet) is (data which may contain the NULL octet) is allowed (e.g., for
allowed (e.g. for storing images etc), and this extension uses the storing images), and this extension uses the "literal8" syntax
"literal8" syntax element [RFC4466] to allow such data to be element [RFC4466] to allow such data to be written to or read from
written to or read from the server. the server.
size size
The size of the value, in octets. Set automatically by the The size of the value, in octets. Set automatically by the
server, read-only to clients. If the client requests the size server, read-only to clients. If the client requests the size
attribute for a non-existent entry, then the server MUST return attribute for a non-existent entry, then the server MUST return
"0" (zero) for the size. "0" (zero) for the size.
4.3. Private versus Shared 3.3. Private Versus Shared
Some IMAP mailboxes are private, accessible only to the owning user. Some IMAP mailboxes are private, accessible only to the owning user.
Other mailboxes are not, either because the owner has set an ACL Other mailboxes are not, either because the owner has set an ACL
[RFC4314] which permits access by other users, or because it is a [RFC4314] that permits access by other users, or because it is a
shared mailbox. shared mailbox.
This raises the issue of shared versus private annotations. This raises the issue of shared versus private annotations.
If all annotations are private, it is impossible to set annotations If all annotations are private, it is then impossible to have
in a shared or otherwise non-private mailbox that are visible to annotations in a shared or otherwise non-private mailbox be visible
other users. This eliminates what could be a useful aspect of to other users. This eliminates what could be a useful aspect of
annotations in a shared environment. An example of such use is a annotations in a shared environment. An example of such use is a
shared IMAP folder containing bug reports. Engineers may want to use shared IMAP folder containing bug reports. Engineers may want to use
annotations to add information to existing messages, indicate annotations to add information to existing messages, indicate
assignments, status, etc. This use requires shared annotations. assignments, status, etc. This use requires shared annotations.
If all annotations are shared, it is impossible to use annotations If all annotations are shared, it is impossible to use annotations
for private notes on messages in shared mailboxes. Also, modifying for private notes on messages in shared mailboxes. Also, modifying
an ACL to permit access to a mailbox by other users may an ACL to permit access to a mailbox by other users may
unintentionally expose private information. unintentionally expose private information.
skipping to change at page 13, line 30 skipping to change at page 8, line 24
set shared annotations on messages in a shared folder, which set shared annotations on messages in a shared folder, which
individual users may wish to supplement with additional notes. individual users may wish to supplement with additional notes.
If shared and private annotations are to coexist, we need a clear way If shared and private annotations are to coexist, we need a clear way
to differentiate them. Also, it should be as easy as possible for a to differentiate them. Also, it should be as easy as possible for a
client to access both and not overlook either. There is also a client to access both and not overlook either. There is also a
danger in allowing a client to store an annotation without knowing if danger in allowing a client to store an annotation without knowing if
it is shared or private. it is shared or private.
This document proposes two standard suffixes for all attributes: This document proposes two standard suffixes for all attributes:
".shared" and ".priv". A SEARCH or FETCH command which specifies ".shared" and ".priv". A SEARCH or FETCH command that specifies
neither uses both. STORE, APPEND and SORT commands MUST explicitly neither, uses both. STORE, APPEND, and SORT commands MUST explicitly
use ".priv" or ".shared" suffixes. use ".priv" or ".shared" suffixes.
If the ANNOTATE extension is present, support for shared annotations If the ANNOTATE extension is present, support for shared annotations
in servers is REQUIRED, whilst support for private annotations in in servers is REQUIRED, while support for private annotations in
servers is OPTIONAL. This recognizes the fact that support for servers is OPTIONAL. This recognizes the fact that support for
private annotations may introduce significantly more complexity to a private annotations may introduce a significant increase in
server in terms of tracking ownership of the annotations, how quota complexity to a server in terms of tracking ownership of the
is determined for users based on their own annotations etc. Clients annotations, how quota is determined for users based on their own
that support the ANNOTATE extension MUST handle both shared and annotations, etc. Clients that support the ANNOTATE extension MUST
private annotations. handle both shared and private annotations.
4.4. Access Control 3.4. Access Control
A user needs to have appropriate rights in order to read or write A user needs to have appropriate rights in order to read or write
".priv" or ".shared" annotation values. How those rights are ".priv" or ".shared" annotation values. How those rights are
calculated depends on whether the ACL [RFC2086] extension or its calculated depends on whether or not the ACL [RFC2086] extension or
update [RFC4314] is present or not. If a client attempts to store or its update [RFC4314] is present. If a client attempts to store or
fetch an annotation to which they do not have the appropriate rights, fetch an annotation to which they do not have the appropriate rights,
the server MUST respond with a NO response. the server MUST respond with a NO response.
When the ACL extension is not present, access to annotation values is When the ACL extension is not present, access to annotation values is
governed by the nature of the selected state. In particular whether governed by the nature of the selected state, in particular whether
the mailbox was SELECT'ed or EXAMINE'd in READ-ONLY or READ-WRITE the mailbox was SELECTED or EXAMINED in READ-ONLY or READ-WRITE mode.
mode.
When the ACL extension is present, the server MUST recognize the new When the ACL extension is present, the server MUST recognize the new
ACL right "n", in addition to the ones defined by the ACL extension ACL "n" right, in addition to the ones defined by the ACL extension
itself. itself.
The "r" right controls both read and write access to ".priv" For ".priv" annotation values, the "r" right controls both read and
annotation values. When it is on, access to ".priv" annotations is write access. When it is on, access to ".priv" annotations is
allowed, when it is off, access to ".priv" annotations is disallowed. allowed; when it is off, access to ".priv" annotations is disallowed.
The "r" right controls only the read access for ".shared" annotation For ".shared" annotation values, the "r" right controls read access.
values. When it is on, ".shared" annotations can be read, when it is When it is on, ".shared" annotations can be read; when it is off,
off, ".shared" annotations cannot be read. ".shared" annotations cannot be read.
The "n" right controls only the write access for ".shared" annotation For ".shared" annotation values, the "n" right controls write access.
values. When it is on, ".shared" annotations can be changed or When it is on, ".shared" annotations can be changed or created
created through either a STORE or APPEND command, when it is off, through either a STORE or APPEND command; when it is off, ".shared"
".shared" annotations cannot be changed or created. The "n" right annotations cannot be changed or created. The "n" right constitutes
constitutes a "shared flag right" as defined in [RFC4314] Section a "shared flag right" as defined in Section 6.2 of [RFC4314].
6.2.
A summary of all the access control restrictions is tabulated below A summary of all the access control restrictions is tabulated below
+---------------+---------------+-----------------------------------+ +---------------+---------------+-----------------------------------+
| Server Type | Action on | Type of mailbox | | Server Type | Action on | Type of mailbox |
| | annotation | | | | annotation | |
+===============+===============+===================================+ +===============+===============+===================================+
| | | | | | | |
| | read .priv | Any mailbox that can be SELECTED | | | read .priv | Any mailbox that can be SELECTED |
| | values | or EXAMINED. | | | values | or EXAMINED. |
| | | | | | | |
| +---------------+-----------------------------------+ | +---------------+-----------------------------------+
| | | | | | | |
skipping to change at page 16, line 5 skipping to change at page 11, line 5
| | read .shared | Any mailbox with the "r" | | | read .shared | Any mailbox with the "r" |
| | values | ACL right. | | | values | ACL right. |
| | | | | | | |
| +---------------+-----------------------------------+ | +---------------+-----------------------------------+
| | | | | | | |
| | write .shared | Any mailbox with the "n" | | | write .shared | Any mailbox with the "n" |
| | values | ACL right. | | | values | ACL right. |
| | | | | | | |
+---------------+---------------+-----------------------------------+ +---------------+---------------+-----------------------------------+
4.5. Access to Standard IMAP Flags and Keywords 3.5. Access to Standard IMAP Flags and Keywords
Due to ambiguity of how private and shared values would map to the Due to the ambiguity of how private and shared values would map to
base IMAP flag and keyword values, the ANNOTATE extension does not the base IMAP flag and keyword values, the ANNOTATE extension does
expose IMAP flags or keywords as entries. However, the /flags not expose IMAP flags or keywords as entries. However, the /flags
annotation entry is reserved for future use and MUST NOT be used by annotation entry is reserved for future use and MUST NOT be used by
clients or servers supporting this extension. clients or servers supporting this extension.
Clients that need to implement shared and private "flags" can create Clients that need to implement shared and private "flags" can create
their own annotation entries for those, completely bypassing the base their own annotation entries for those, completely bypassing the base
IMAP flag/keyword behavior. IMAP flag/keyword behavior.
5. IMAP Protocol Changes 4. IMAP Protocol Changes
5.1. General Considerations 4.1. General Considerations
Servers may be able to offer only a limited level of support for Servers may be able to offer only a limited level of support for
annotations in mailboxes, and it is useful for clients to be able to annotations in mailboxes, and it is useful for clients to be able to
know what level of support is available. Servers MUST return an know what level of support is available. Servers MUST return an
ANNOTATIONS response code during the SELECT or EXAMINE command for a ANNOTATIONS response code during the SELECT or EXAMINE command for a
mailbox to indicate the level of support. Possible data items used mailbox to indicate the level of support. Possible data items used
with the ANNOTATIONS response code are: with the ANNOTATIONS response code are:
"NONE" - this indicates that the mailbox being selected does not "NONE" - this indicates that the mailbox being selected does not
support annotations at all. Clients MUST NOT attempt to use support annotations at all. Clients MUST NOT attempt to use
annotation extensions in commands. annotation extensions in commands for this mailbox.
"READ-ONLY" - this indicates that the annotations supported by the "READ-ONLY" - this indicates that the annotations supported by the
mailbox cannot be changed by the client. Clients MUST NOT attempt mailbox cannot be changed by the client. Clients MUST NOT attempt
to store annotations on any messages in a mailbox with this to store annotations on any messages in a mailbox with this
response code. response code.
"NOPRIVATE" - this indicates that the server does not support "NOPRIVATE" - this indicates that the server does not support
private annotations on the mailbox. Only shared annotations are private annotations on the mailbox. Only shared annotations are
supported. Clients SHOULD only attempt to read or store supported. Clients SHOULD only attempt to read or store
annotations attributes with the ".shared" suffix. If a client annotations attributes with the ".shared" suffix. If a client
uses an attribute with the ".priv" suffix in a FETCH command, then uses an attribute with the ".priv" suffix in a FETCH command, then
servers should return the attribute value in the FETCH response as servers should return the attribute value in the FETCH response as
"NIL". If a client uses an attribute with the ".priv" suffix in a "NIL". If a client uses an attribute with the ".priv" suffix in a
STORE command (or an APPEND command targeted at the mailbox) then STORE command (or an APPEND command targeted at the mailbox), then
the server MUST return a NO response. the server MUST return a NO response.
numeric values - if servers support writable annotations, then the numeric values - if servers support writable annotations, then the
server MUST indicate the maximum size for an annotation value by server MUST indicate the maximum size in octets for an annotation
providing the maximum size value in the response code. Clients value by providing the maximum size value in the response code.
MUST NOT store annotation values of a size greater than the amount Clients MUST NOT store annotation values of a size greater than
indicated by the server. Servers MUST accept a minimum annotation the amount indicated by the server. Servers MUST accept a minimum
data size of at least 1024 bytes if annotations can be written. annotation data size of at least 1024 octets if annotations can be
written.
In addition the server MAY limit the total number of annotations for In addition, the server MAY limit the total number of annotations for
a single message. However, the server MUST provide a minimum a single message. However, the server MUST provide a minimum
annotation count per message of at least 10. annotation count per message of at least 10.
5.2. ANNOTATE parameter with the SELECT/EXAMINE commands 4.2. ANNOTATE Parameter with the SELECT/EXAMINE Commands
The ANNOTATE extension defines a single optional SELECT parameter The ANNOTATE extension defines a single optional SELECT parameter
[RFC4466] "ANNOTATE", which is used to turn on unsolicited responses [RFC4466] "ANNOTATE", which is used to turn on unsolicited responses
for annotations as described in Section 5.4. This optional parameter for annotations as described in Section 4.4. This optional parameter
results in a per-mailbox state change, i.e. it must be used in each results in a per-mailbox state change, i.e., it must be used in each
SELECT/EXAMINE command in order to be effective, irrespective of SELECT/EXAMINE command in order to be effective, irrespective of
whether it was used in a previous SELECT/EXAMINE during the same whether it was used in a previous SELECT/EXAMINE during the same
session. session.
Example: Example:
C: a SELECT INBOX (ANNOTATE) C: a SELECT INBOX (ANNOTATE)
S: * FLAGS (\Answered \Flagged \Draft \Deleted \Seen) S: * FLAGS (\Answered \Flagged \Draft \Deleted \Seen)
S: * OK [PERMANENTFLAGS (\Answered \Flagged \Draft S: * OK [PERMANENTFLAGS (\Answered \Flagged \Draft
\Deleted \Seen \*)] \Deleted \Seen \*)]
S: * 10268 EXISTS S: * 10268 EXISTS
S: * 1 RECENT S: * 1 RECENT
S: * OK [UNSEEN 10268] S: * OK [UNSEEN 10268]
S: * OK [UIDVALIDITY 890061587] S: * OK [UIDVALIDITY 890061587]
S: * OK [UIDNEXT 34643] S: * OK [UIDNEXT 34643]
S: * OK [ANNOTATIONS 20480 NOPRIVATE] S: * OK [ANNOTATIONS 20480 NOPRIVATE]
S: a OK [READ-WRITE] Completed S: a OK [READ-WRITE] Completed
In the above example, a SELECT command with the ANNOTATE parameter In the above example, a SELECT command with the ANNOTATE parameter
is issued. The response from the server includes the required is issued. The response from the server includes the required
ANNOTATIONS response that indicates that the server supports ANNOTATIONS response that indicates that the server supports
annotations up to a maximum size of 20480 bytes and does not annotations up to a maximum size of 20480 octets, and does not
support private annotations (only shared). support private annotations (only shared).
5.3. ANNOTATION Message Data Item in FETCH Command 4.3. ANNOTATION Message Data Item in FETCH Command
This extension adds an ANNOTATION message data item to the FETCH This extension adds an ANNOTATION message data item to the FETCH
command. This allows clients to retrieve annotations for a range of command. This allows clients to retrieve annotations for a range of
messages in the currently selected mailbox. messages in the currently selected mailbox.
ANNOTATION <entry-specifier> <attribute-specifier> ANNOTATION <entry-specifier> <attribute-specifier>
The ANNOTATION message data item, when used by the client in the The ANNOTATION message data item, when used by the client in the
FETCH command, takes an entry specifier and an attribute FETCH command, takes an entry specifier and an attribute
specifier. specifier.
skipping to change at page 18, line 20 skipping to change at page 13, line 20
value.shared "Group note"))) value.shared "Group note")))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, the content of the "value" attribute for the In the above example, the content of the "value" attribute for the
"/comment" entry is requested by the client and returned by the "/comment" entry is requested by the client and returned by the
server. Since neither ".shared" nor ".priv" was specified, both server. Since neither ".shared" nor ".priv" was specified, both
are returned. are returned.
"*" and "%" wild card characters can be used in entry specifiers to "*" and "%" wild card characters can be used in entry specifiers to
match one or more characters at that position, with the exception match one or more characters at that position, with the exception
that "%" does not match the "/" hierarchy delimiter. Thus an entry that "%" does not match the "/" hierarchy delimiter. Thus, an entry
specifier of "/%" matches entries such as "/comment" and specifier of "/%" matches entries such as "/comment" and
"/altsubject", but not "/1/comment". "/altsubject", but not "/1/comment".
Example: Example:
C: a UID FETCH 1123 (UID ANNOTATION C: a UID FETCH 1123 (UID ANNOTATION
(/* (value.priv size.priv))) (/* (value.priv size.priv)))
S: * 12 FETCH (UID 1123 ANNOTATION S: * 12 FETCH (UID 1123 ANNOTATION
(/comment (value.priv "My comment" (/comment (value.priv "My comment"
size.priv "10") size.priv "10")
skipping to change at page 19, line 26 skipping to change at page 14, line 35
((/comment /altsubject) value.priv)) ((/comment /altsubject) value.priv))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(/comment (value.priv "What a chowder-head") (/comment (value.priv "What a chowder-head")
/altsubject (value.priv "How to crush beer cans"))) /altsubject (value.priv "How to crush beer cans")))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, the contents of the private "value" In the above example, the contents of the private "value"
attributes for the two entries "/comment" and "/altsubject" are attributes for the two entries "/comment" and "/altsubject" are
requested by the client and returned by the server. requested by the client and returned by the server.
5.4. ANNOTATION Message Data Item in FETCH Response 4.4. ANNOTATION Message Data Item in FETCH Response
The ANNOTATION message data item in the FETCH response displays The ANNOTATION message data item in the FETCH response displays
information about annotations in a message. information about annotations in a message.
ANNOTATION parenthesized list ANNOTATION parenthesized list
The response consists of a list of entries, each of which has a The response consists of a list of entries, each of which have a
list of attribute-value pairs. list of attribute-value pairs.
Example: Example:
C: a FETCH 1 (ANNOTATION (/comment value)) C: a FETCH 1 (ANNOTATION (/comment value))
S: * 1 FETCH (ANNOTATION (/comment S: * 1 FETCH (ANNOTATION (/comment
(value.priv "My comment" (value.priv "My comment"
value.shared NIL))) value.shared NIL)))
S: a OK Fetch complete S: a OK Fetch complete
skipping to change at page 20, line 14 skipping to change at page 15, line 29
C: a FETCH 1 (ANNOTATION C: a FETCH 1 (ANNOTATION
((/comment /altsubject) value)) ((/comment /altsubject) value))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(/comment (value.priv "My comment" (/comment (value.priv "My comment"
value.shared NIL) value.shared NIL)
/altsubject (value.priv "My subject" /altsubject (value.priv "My subject"
value.shared NIL))) value.shared NIL)))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, two entries each with a single attribute- In the above example, two entries, each with a single attribute-
value pair are returned by the server. Since the client did not value pair, are returned by the server. Since the client did not
specify a ".shared" or ".priv" suffix, both are returned. Only specify a ".shared" or ".priv" suffix, both are returned. Only
the private attributes have values; the shared attributes are the private attributes have values; the shared attributes are
"NIL". "NIL".
Example: Example:
C: a FETCH 1 (ANNOTATION C: a FETCH 1 (ANNOTATION
(/comment (value size))) (/comment (value size)))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(/comment (/comment
skipping to change at page 20, line 43 skipping to change at page 16, line 11
pairs is returned by the server. Since the client did not specify pairs is returned by the server. Since the client did not specify
a ".shared" or ".priv" suffix, both are returned. Only the a ".shared" or ".priv" suffix, both are returned. Only the
private attributes have values; the shared attributes are "NIL". private attributes have values; the shared attributes are "NIL".
Servers SHOULD send ANNOTATION message data items in unsolicited Servers SHOULD send ANNOTATION message data items in unsolicited
FETCH responses if an annotation entry is changed by a third-party, FETCH responses if an annotation entry is changed by a third-party,
and the ANNOTATE select parameter was used. This allows servers to and the ANNOTATE select parameter was used. This allows servers to
keep clients updated with changes to annotations by other clients. keep clients updated with changes to annotations by other clients.
Unsolicited ANNOTATION responses MUST NOT include ANNOTATION data Unsolicited ANNOTATION responses MUST NOT include ANNOTATION data
values - only the entry name of the ANNOTATION that has changed. values -- only the entry name of the ANNOTATION that has changed.
This restriction avoids sending ANNOTATION data values (which may be This restriction avoids sending ANNOTATION data values (which may be
large) to a client unless the client explicitly asks for the value. large) to a client unless the client explicitly asks for the value.
Example: Example:
C: a STORE 1 +FLAGS (\Seen) C: a STORE 1 +FLAGS (\Seen)
S: * 1 FETCH (FLAGS (\Seen)) S: * 1 FETCH (FLAGS (\Seen))
ANNOTATION (/comment)) ANNOTATION (/comment))
S: a OK STORE complete S: a OK STORE complete
In the above example, an unsolicited ANNOTATION response is In the above example, an unsolicited ANNOTATION response is
returned during a STORE command. The unsolicited response returned during a STORE command. The unsolicited response
contains only the entry name of the annotation that changed, and contains only the entry name of the annotation that changed, and
not its value. not its value.
5.5. ANNOTATION Message Data Item in STORE 4.5. ANNOTATION Message Data Item in STORE
ANNOTATION <parenthesized entry-attribute-value list> ANNOTATION <parenthesized entry-attribute-value list>
Sets the specified list of entries by adding or replacing the Sets the specified list of entries by adding or replacing the
specified attributes with the values provided. Clients can use specified attributes with the values provided. Clients can use
"NIL" for values of attributes it wants to remove from entries. "NIL" for values of attributes it wants to remove from entries.
The ANNOTATION message data item used with the STORE command has an The ANNOTATION message data item used with the STORE command has an
implicit ".SILENT" behavior. This means the server does not generate implicit ".SILENT" behavior. This means the server does not generate
an untagged FETCH in response to the STORE command and assumes that an untagged FETCH in response to the STORE command and assumes that
skipping to change at page 21, line 42 skipping to change at page 17, line 12
MUST return a tagged NO response with a "[ANNOTATE TOOMANY]" response MUST return a tagged NO response with a "[ANNOTATE TOOMANY]" response
code. code.
Example: Example:
C: a STORE 1 ANNOTATION (/comment C: a STORE 1 ANNOTATION (/comment
(value.priv "My new comment")) (value.priv "My new comment"))
S: a OK Store complete S: a OK Store complete
In the above example, the entry "/comment" is created (if not In the above example, the entry "/comment" is created (if not
already present) and the private attribute "value" with data set already present). Its private attribute "value" is created if not
to "My new comment" is created if not already present, or replaced already present, or replaced if it exists. "value.priv" is set to
if it exists. "My new comment".
Example: Example:
C: a STORE 1 ANNOTATION (/comment C: a STORE 1 ANNOTATION (/comment
(value.shared NIL)) (value.shared NIL))
S: a OK Store complete S: a OK Store complete
In the above example, the shared "value" attribute of the entry In the above example, the shared "value" attribute of the entry
"/comment" is removed by storing "NIL" into the attribute. "/comment" is removed by storing "NIL" into the attribute.
Multiple entries can be set in a single STORE command by listing Multiple entries can be set in a single STORE command by listing
entry-attribute-value pairs in the list. entry-attribute-value pairs in the list.
Example: Example:
C: a STORE 1 ANNOTATION (/comment C: a STORE 1 ANNOTATION (/comment
(value.priv "Get tix Tuesday") (value.priv "Get tix Tuesday")
/altsubject /altsubject
(value.priv "Wots On")) (value.priv "Wots On"))
S: a OK Store complete S: a OK Store complete
In the above example, the entries "/comment" and "/altsubject" are In the above example, the entries "/comment" and "/altsubject" are
created (if not already present) and the private attribute "value" created (if not already present) and the private attribute "value"
is created for each entry if not already present, or replaced if is created or replaced for each entry.
they exist.
Multiple attributes can be set in a single STORE command by listing Multiple attributes can be set in a single STORE command by listing
multiple attribute-value pairs in the entry list. multiple attribute-value pairs in the entry list.
Example: Example:
C: a STORE 1 ANNOTATION (/comment C: a STORE 1 ANNOTATION (/comment
(value.priv "My new comment" (value.priv "My new comment"
value.shared "foo's bar")) value.shared "foo's bar"))
S: a OK Store complete S: a OK Store complete
In the above example, the entry "/comment" is created (if not already In the above example, the entry "/comment" is created (if not
present) and the private and shared "value" attributes are created if already present) and the private and shared "value" attributes are
not already present, or replaced if they exist. created if not already present, or replaced if they exist.
5.6. ANNOTATION interaction with COPY 4.6. ANNOTATION Interaction with COPY
The COPY command can be used to move messages from one mailbox to The COPY command can be used to move messages from one mailbox to
another on the same server. Servers that support the ANNOTATION another on the same server. Servers that support the ANNOTATION
extension MUST, for each message being copied, copy all ".priv" extension MUST, for each message being copied, copy all ".priv"
annotation data for the current user only, and all ".shared" annotation data for the current user only, and all ".shared"
annotation data along with the message to the new mailbox. The only annotation data along with the message to the new mailbox. The only
exceptions to this are if the destination mailbox permissions are exceptions to this are if the destination mailbox permissions are
such that either the ".priv" or ".shared" annotations are not such that either the ".priv" or ".shared" annotations are not
allowed, or if the destination mailbox is of a type that does not allowed, or if the destination mailbox is of a type that does not
support annotations or does not support storing of annotations (a support annotations or does not support storing of annotations (a
mailbox that returns a "NONE" or "READ-ONLY" response code in its mailbox that returns a "NONE" or "READ-ONLY" response code in its
ANNOTATIONS response), or if the destination mailbox cannot support ANNOTATIONS response), or if the destination mailbox cannot support
the size of a annotation because it exceeds the ANNOTATIONS value. the size of an annotation because it exceeds the ANNOTATIONS value.
Servers MUST NOT copy ".priv" annotation data for users other than Servers MUST NOT copy ".priv" annotation data for users other than
the current user. the current user.
5.7. ANNOTATION Message Data Item in APPEND 4.7. ANNOTATION Message Data Item in APPEND
ANNOTATION <parenthesized entry-attribute-value list> ANNOTATION <parenthesized entry-attribute-value list>
Sets the specified list of entries and attributes in the resulting Sets the specified list of entries and attributes in the resulting
message. message.
The APPEND command can include annotations for the message being The APPEND command can include annotations for the message being
appended via the addition of a new append data item [RFC4466]. The appended via the addition of a new append data item [RFC4466]. The
new data item can also be used with the multi-append [RFC3502] new data item can also be used with the multi-append [RFC3502]
extension that allows multiple messages to be appended via a single extension that allows multiple messages to be appended via a single
skipping to change at page 23, line 33 skipping to change at page 19, line 19
S: + Ready for literal data S: + Ready for literal data
C: MIME-Version: 1.0 C: MIME-Version: 1.0
... ...
C: C:
S: a OK APPEND completed S: a OK APPEND completed
In the above example, a comment with a private value is added to a In the above example, a comment with a private value is added to a
new message appended to the mailbox. The ellipsis represents the new message appended to the mailbox. The ellipsis represents the
bulk of the message. bulk of the message.
5.8. ANNOTATION Criterion in SEARCH 4.8. ANNOTATION Criterion in SEARCH
ANNOTATION <entry-name> <attribute-name> <value> ANNOTATION <entry-name> <attribute-name> <value>
The ANNOTATION criterion for the SEARCH command allows a client to The ANNOTATION criterion for the SEARCH command allows a client to
search for a specified string in the value of an annotation entry of search for a specified string in the value of an annotation entry of
a message. a message.
Messages that have annotations with entries matching <entry-name> and Messages that have annotations with entries matching <entry-name>,
attributes matching <attribute-name> and the specified string <value> attributes matching <attribute-name>, and the specified string
in their values are returned in the SEARCH results. The "*" <value> in their values are returned in the SEARCH results. The "*"
character can be used in the entry name field to match any content in character can be used in the entry name field to match any content in
those items. The "%" character can be used in the entry name field those items. The "%" character can be used in the entry name field
to match a single level of hierarchy only. to match a single level of hierarchy only.
Only the "value", "value.priv" and "value.shared" attributes can be Only the "value", "value.priv", and "value.shared" attributes can be
searched. Clients MUST NOT specify an attribute other than either searched. Clients MUST NOT specify an attribute other than either
"value", "value.priv" or "value.shared". Servers MUST return a BAD "value", "value.priv", or "value.shared". Servers MUST return a BAD
response if the client tries to search any other attribute. response if the client tries to search any other attribute.
Example: Example:
C: a SEARCH ANNOTATION /comment value "IMAP4" C: a SEARCH ANNOTATION /comment value "IMAP4"
S: * SEARCH 2 3 5 7 11 13 17 19 23 S: * SEARCH 2 3 5 7 11 13 17 19 23
S: a OK Search complete S: a OK Search complete
In the above example, the message numbers of any messages In the above example, the message numbers of any messages
containing the string "IMAP4" in the shared or private "value" containing the string "IMAP4" in the shared or private "value"
skipping to change at page 24, line 26 skipping to change at page 20, line 15
Example: Example:
C: a SEARCH ANNOTATION * value.priv "IMAP4" C: a SEARCH ANNOTATION * value.priv "IMAP4"
S: * SEARCH 1 2 3 5 8 13 21 34 S: * SEARCH 1 2 3 5 8 13 21 34
S: a OK Search complete S: a OK Search complete
In the above example, the message numbers of any messages In the above example, the message numbers of any messages
containing the string "IMAP4" in the private "value" attribute of containing the string "IMAP4" in the private "value" attribute of
any entry are returned in the search results. any entry are returned in the search results.
5.9. ANNOTATION Key in SORT 4.9. ANNOTATION Key in SORT
ANNOTATION <entry-name> <attribute-name> ANNOTATION <entry-name> <attribute-name>
The ANNOTATION criterion for the SORT command [I-D.ietf-imapext-sort] The ANNOTATION criterion for the SORT command [RFC5256] instructs the
instructs the server to return the message numbers or UIDs of a server to return the sequence numbers or Unique Identifiers (UIDs) of
mailbox, sorted using the values of the specified annotations. The messages in a mailbox, sorted using the values of the specified
ANNOTATION criterion is available if the server returns both annotations. The ANNOTATION criterion is available if the server
ANNOTATE-EXPERIMENT-1 and SORT as supported capabilities in the returns both ANNOTATE-EXPERIMENT-1 and SORT as supported capabilities
CAPABILITY command response. in the CAPABILITY command response.
Messages are sorted using the values of the <attribute-name> Messages are sorted using the values of the <attribute-name>
attributes in the <entry-name> entries. attributes in the <entry-name> entries.
Clients MUST provide either the ".priv" or ".shared" suffix to the Clients MUST provide either the ".priv" or ".shared" suffix to the
attribute name to ensure that the server knows which specific value attribute name to ensure that the server knows which specific value
to sort on. to sort on.
Only the "value.priv" and "value.shared" attributes can be used for Only the "value.priv" and "value.shared" attributes can be used for
sorting. Clients MUST NOT specify an attribute other than either sorting. Clients MUST NOT specify an attribute other than either
skipping to change at page 25, line 16 skipping to change at page 21, line 6
C: a SORT (ANNOTATION /altsubject value.shared) UTF-8 ALL C: a SORT (ANNOTATION /altsubject value.shared) UTF-8 ALL
S: * SORT 2 3 4 5 1 11 10 6 7 9 8 S: * SORT 2 3 4 5 1 11 10 6 7 9 8
S: a OK Sort complete S: a OK Sort complete
In the above example, the message numbers of all messages are In the above example, the message numbers of all messages are
returned, sorted according to the shared "value" attribute of the returned, sorted according to the shared "value" attribute of the
"/altsubject" entry. "/altsubject" entry.
Note that the ANNOTATION sort key must include a fully specified Note that the ANNOTATION sort key must include a fully specified
entry - wild cards are not allowed. entry -- wild cards are not allowed.
5.10. New ACL Rights 4.10. New ACL Rights
As discussed in Section 4.4 this extension adds a new "n" right to As discussed in Section 3.4, this extension adds a new "n" right to
the list of rights provided by the ACL extensions [RFC2086] and the list of rights provided by the ACL extensions [RFC2086] and
[RFC4314]. [RFC4314].
6. Formal Syntax 5. Formal Syntax
The following syntax specification uses the Augmented Backus-Naur The following syntax specification uses the Augmented Backus-Naur
Form (ABNF) notation as specified in [RFC2234]. Form (ABNF) notation as specified in [RFC5234].
Non-terminals referenced but not defined below are as defined by Non-terminals referenced but not defined below are as defined by
[RFC3501] with the new definitions in [RFC4466] superseding those in [RFC3501] with the new definitions in [RFC4466] superseding those in
[RFC3501]. [RFC3501].
Except as noted otherwise, all alphabetic characters are case- Except as noted otherwise, all alphabetic characters are case-
insensitive. The use of upper or lower case characters to define insensitive. The use of upper or lower case characters to define
token strings is for editorial clarity only. Implementations MUST token strings is for editorial clarity only. Implementations MUST
accept these strings in a case-insensitive fashion. accept these strings in a case-insensitive fashion.
ann-size = "NONE" / ann-size = "NONE" /
(("READ-ONLY" / nz-size) (("READ-ONLY" / nz-number)
[SP "NOPRIVATE"]) [SP "NOPRIVATE"])
; response codes indicating the level of ; response codes indicating the level of
; support for annotations in a mailbox ; support for annotations in a mailbox
append-ext =/ att-annotate append-ext =/ att-annotate
; modifies [RFC3501] extension behaviour ; modifies [RFC3501] extension behaviour
att-annotate = "ANNOTATION" SP att-annotate = "ANNOTATION" SP
"(" entry-att *(SP entry-att) ")" "(" entry-att *(SP entry-att) ")"
skipping to change at page 27, line 13 skipping to change at page 23, line 5
; ANNOTATE extension ; ANNOTATE extension
sort-key =/ "ANNOTATION" SP entry SP att-sort sort-key =/ "ANNOTATION" SP entry SP att-sort
; modifies original sort-key ; modifies original sort-key
store-att-flags =/ att-annotate store-att-flags =/ att-annotate
; modifies original IMAP STORE command ; modifies original IMAP STORE command
value = nstring / literal8 value = nstring / literal8
7. IANA Considerations 6. IANA Considerations
Entry names MUST be specified in a standards track or IESG approved Entry names MUST be specified in a standards track or IESG approved
experimental RFC, or fall under the vendor namespace. Vendor names experimental RFC, or fall under the vendor namespace. Vendor names
MUST be registered. MUST be registered.
Attribute names MUST be specified in a standards track or IESG Attribute names MUST be specified in a standards track or IESG
approved experimental RFC. approved experimental RFC.
Each entry registration MUST include a content-type that is used to Each entry registration MUST include a content-type that is used to
indicate the nature of the annotation value. Where applicable a indicate the nature of the annotation value. Where applicable, a
charset parameter MUST be included with the content-type. charset parameter MUST be included with the content-type.
7.1. Entry and Attribute Registration Template 6.1. Entry and Attribute Registration Template
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[] Entry [] Attribute [] Entry [] Attribute
Name: ______________________________ Name: ______________________________
Description: _______________________ Description: _______________________
____________________________________ ____________________________________
____________________________________ ____________________________________
Content-Type:_______________________ Content-Type:_______________________
Contact person: ____________________ Contact person: ____________________
email: ____________________ email: ____________________
7.2. Entry Registrations 6.2. Entry Registrations
The following templates specify the IANA registrations of annotation The following templates specify the IANA registrations of annotation
entries specified in this document. entries specified in this document.
7.2.1. /comment 6.2.1. /comment
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[X] Entry [] Attribute [X] Entry [] Attribute
Name: /comment Name: /comment
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8 Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.2.2. /flags 6.2.2. /flags
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[X] Entry [] Attribute [X] Entry [] Attribute
Name: /flags Name: /flags
Description: Reserved entry hierarchy. Description: Reserved entry hierarchy.
Content-Type: - Content-Type: -
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.2.3. /altsubject 6.2.3. /altsubject
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[X] Entry [] Attribute [X] Entry [] Attribute
Name: /altsubject Name: /altsubject
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8 Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.2.4. /<section-part>/comment 6.2.4. /<section-part>/comment
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[X] Entry [] Attribute [X] Entry [] Attribute
Name: /<section-part>/comment Name: /<section-part>/comment
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8 Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.2.5. /<section-part>/flags/seen 6.2.5. /<section-part>/flags/seen
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[X] Entry [] Attribute [X] Entry [] Attribute
Name: /<section-part>/flags/seen Name: /<section-part>/flags/seen
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8 Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.2.6. /<section-part>/flags/answered 6.2.6. /<section-part>/flags/answered
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[X] Entry [] Attribute [X] Entry [] Attribute
Name: /<section-part>/flags/answered Name: /<section-part>/flags/answered
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8 Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.2.7. /<section-part>/flags/flagged 6.2.7. /<section-part>/flags/flagged
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[X] Entry [] Attribute [X] Entry [] Attribute
Name: /<section-part>/flags/flagged Name: /<section-part>/flags/flagged
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8 Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.2.8. /<section-part>/flags/forwarded 6.2.8. /<section-part>/flags/forwarded
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[X] Entry [] Attribute [X] Entry [] Attribute
Name: /<section-part>/flags/forwarded Name: /<section-part>/flags/forwarded
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8 Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.3. Attribute Registrations 6.3. Attribute Registrations
The following templates specify the IANA registrations of annotation The following templates specify the IANA registrations of annotation
attributes specified in this document. attributes specified in this document.
7.3.1. value 6.3.1. value
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[] Entry [X] Attribute [] Entry [X] Attribute
Name: value Name: value
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
7.3.2. size 6.3.2. size
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[] Entry [X] Attribute [] Entry [X] Attribute
Name: size Name: size
Description: Defined in IMAP ANNOTATE extension document. Description: Defined in IMAP ANNOTATE extension document.
Contact person: Cyrus Daboo Contact person: Cyrus Daboo
email: cyrus@daboo.name email: cyrus@daboo.name
8. Internationalization Considerations 7. Internationalization Considerations
Annotations may contain values that include text strings, and both Annotations may contain values that include text strings, and both
searching and sorting are possible with annotations. Servers MUST searching and sorting are possible with annotations. Servers MUST
follow standard IMAP text normalization, character set conversion and follow standard IMAP text normalization, character set conversion,
collation rules when such operations are carried out, as they would and collation rules when such operations are carried out, as would be
for other textual fields being searched or sorted on. done for other textual fields being searched or sorted on.
9. Security Considerations 8. Security Considerations
Annotations whose values are intended to remain private MUST be Annotations whose values are intended to remain private MUST be
stored in ".priv" values, and not ".shared" values which may be stored in ".priv" values instead of ".shared" values, which may be
accessible to other users. accessible to other users.
Excluding the above issues the ANNOTATE extension does not raise any Excluding the above issues, the ANNOTATE extension does not raise any
security considerations that are not present in the base IMAP security considerations that are not present in the base IMAP
protocol, and these issues are discussed in [RFC3501]. protocol; these issues are discussed in [RFC3501].
10. References
10.1. Normative References 9. References
[I-D.ietf-imapext-sort] 9.1. Normative References
Crispin, M. and K. Murchison, "INTERNET MESSAGE ACCESS
PROTOCOL - SORT AND THREAD EXTENSION",
draft-ietf-imapext-sort-17 (work in progress), May 2004.
[RFC2086] Myers, J., "IMAP4 ACL extension", RFC 2086, January 1997. [RFC2086] Myers, J., "IMAP4 ACL extension", RFC 2086, January 1997.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", RFC 2234, November 1997.
[RFC2244] Newman, C. and J. Myers, "ACAP -- Application [RFC2244] Newman, C. and J. Myers, "ACAP -- Application
Configuration Access Protocol", RFC 2244, November 1997. Configuration Access Protocol", RFC 2244, November 1997.
[RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION [RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION
4rev1", RFC 3501, March 2003. 4rev1", RFC 3501, March 2003.
[RFC3502] Crispin, M., "Internet Message Access Protocol (IMAP) - [RFC3502] Crispin, M., "Internet Message Access Protocol (IMAP) -
MULTIAPPEND Extension", RFC 3502, March 2003. MULTIAPPEND Extension", RFC 3502, March 2003.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, November 2003. 10646", STD 63, RFC 3629, November 2003.
[RFC4314] Melnikov, A., "IMAP4 Access Control List (ACL) Extension", [RFC4314] Melnikov, A., "IMAP4 Access Control List (ACL) Extension",
RFC 4314, December 2005. RFC 4314, December 2005.
[RFC4466] Melnikov, A. and C. Daboo, "Collected Extensions to IMAP4 [RFC4466] Melnikov, A. and C. Daboo, "Collected Extensions to IMAP4
ABNF", RFC 4466, April 2006. ABNF", RFC 4466, April 2006.
10.2. Informative References [RFC5234] Crocker, D., Ed., and P. Overell, "Augmented BNF for
Syntax Specifications: ABNF", STD 68, RFC 5234, January
2008.
[RFC5256] Crispin, M. and K. Murchison, "Internet Message Access
Protocol - SORT and THREAD Extensions", RFC 5256, June
2008.
9.2. Informative References
[RFC4551] Melnikov, A. and S. Hole, "IMAP Extension for Conditional [RFC4551] Melnikov, A. and S. Hole, "IMAP Extension for Conditional
STORE Operation or Quick Flag Changes Resynchronization", STORE Operation or Quick Flag Changes Resynchronization",
RFC 4551, June 2006. RFC 4551, June 2006.
Appendix A. Acknowledgments 10. Acknowledgments
Many thanks to Chris Newman for his detailed comments on the first Many thanks to Chris Newman for his detailed comments on the first
draft of this document, and to the participants at the ACAP working draft of this document, and to the participants at the ACAP working
dinner in Pittsburgh. The participants of the IMAPext working group dinner in Pittsburgh. The participants of the IMAPext working group
made significant contributions to this work. made significant contributions to this work.
Authors' Addresses Authors' Addresses
Cyrus Daboo Cyrus Daboo
Apple Computer, Inc. Apple Inc.
1 Infinite Loop 1 Infinite Loop
Cupertino, CA 95014 Cupertino, CA 95014
USA USA
Email: cyrus@daboo.name EMail: cyrus@daboo.name
URI: http://www.apple.com/ URI: http://www.apple.com/
Randall Gellens Randall Gellens
QUALCOMM Incorporated QUALCOMM Incorporated
5775 Morehouse Dr. 5775 Morehouse Dr.
San Diego, CA 92121-2779 San Diego, CA 92121-2779
US USA
Email: randy@qualcomm.com EMail: randy@qualcomm.com
Full Copyright Statement Full Copyright Statement
Copyright (C) The Internet Society (2006). Copyright (C) The IETF Trust (2008).
This document is subject to the rights, licenses and restrictions This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors contained in BCP 78, and except as set forth therein, the authors
retain all their rights. retain all their rights.
This document and the information contained herein are provided on an This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property Intellectual Property
The IETF takes no position regarding the validity or scope of any The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information made any independent effort to identify any such rights. Information
skipping to change at page 35, line 44 skipping to change at line 1326
attempt made to obtain a general license or permission for the use of attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr. http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at this standard. Please address the information to the IETF at
ietf-ipr@ietf.org. ietf-ipr@ietf.org.
Acknowledgment
Funding for the RFC Editor function is provided by the IETF
Administrative Support Activity (IASA).
 End of changes. 218 change blocks. 
613 lines changed or deleted 386 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/