IMAP Extensions Working Group C. Daboo
Internet-Draft Apple Computer
Intended status: Informational R. Gellens
Expires: February 2, 2007 QUALCOMM Incorporated
August 2006
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.
Copyright Notice
Copyright (C) The Internet Society (2006).
Abstract
The ANNOTATE extension to the Internet Message Access Protocol
permits clients and servers to maintain "meta data" for messages, or
individual message parts, stored in a mailbox on the server. For
example, this can be used to attach comments and other useful
information to a message. It is also possible to attach annotations
to specific parts of a message, so that, for example, they could be
marked as seen or important, or a comment added.
Daboo & Gellens Expires February 2, 2007 [Page 1]
Internet-Draft IMAP ANNOTATE Extension August 2006
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.
Daboo & Gellens Expires February 2, 2007 [Page 2]
Internet-Draft IMAP ANNOTATE Extension August 2006
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.
Daboo & Gellens Expires February 2, 2007 [Page 3]
Internet-Draft IMAP ANNOTATE Extension August 2006
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:
1. ANNOTATESIZE response changed to use "NIL" for a mailbox that
does not support any type of annotations, and "0" for a mailbox
that only supports read-only annotations.
Changes from -06 to -07:
1. Added text to state entry and attribute names are always case-
insensitive.
2. Removed top-level entry namespace.
3. Added server accept minima for annotation size and count.
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:
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.
Daboo & Gellens Expires February 2, 2007 [Page 4]
Internet-Draft IMAP ANNOTATE Extension August 2006
8. Fixed STORE syntax.
Changes from -04 to -05:
1. Fixed examples to match formal syntax for FETCH responses where
parenthesis do not appear around entry-att items.
Changes from -03 to -04:
1. Fixed attrib/attrib-match grammar to use "." instead of "/".
2. Add text for server to reject unknown <part-specifier>.
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:
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:
1. Now require .priv or .shared on store operations.
Changes from -00 to -01:
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:
1. Clarified text describing attributions, entries, and attributes.
Daboo & Gellens Expires February 2, 2007 [Page 5]
Internet-Draft IMAP ANNOTATE Extension August 2006
2. Changed 'modifiedsince' to 'modtime'; referenced ACAP spec.
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.
Daboo & Gellens Expires February 2, 2007 [Page 6]
Internet-Draft IMAP ANNOTATE Extension August 2006
Table of Contents
1. Introduction and Overview . . . . . . . . . . . . . . . . . . 8
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
Daboo & Gellens Expires February 2, 2007 [Page 7]
Internet-Draft IMAP ANNOTATE Extension August 2006
1. Introduction and Overview
The ANNOTATE extension is present in any IMAP [RFC3501]
implementation which returns "ANNOTATE-EXPERIMENT-1" as one of the
supported capabilities in the CAPABILITY response.
This extension makes the following changes to the IMAP protocol:
a. adds a new ANNOTATION message data item for use in FETCH
b. adds a new ANNOTATION message data item for use in STORE
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
of the Application Configuration Access Protocol [RFC2244]. Note
that there is no inheritance in annotations.
If a server supports annotations, then it MUST store all annotation
data permanently, i.e. there is no concept of "session only"
annotations that would correspond to the behavior of "session" flags
as defined in the IMAP base specification.
In order to provide optimum support for a disconnected client (one
that needs to synchronize annotations for use when offline), servers
SHOULD also support the Conditional STORE [RFC4551] extension.
The rest of this document describes the data model and protocol
changes more rigorously.
2. Working Group Note on Status
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
Daboo & Gellens Expires February 2, 2007 [Page 8]
Internet-Draft IMAP ANNOTATE Extension August 2006
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
server respectively.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
4. Data Model
4.1. Overview
The data model used in ANNOTATE is that of a uniquely named entry
which contains a set of standard attributes. A single coherent unit
of "meta data" for a message is stored as a single entry, made up of
several attributes.
For example, a comment annotation added to a message has an entry
name of "/comment". This entry is composed of several attributes
such as "value", "size", etc. which contain the properties and data
of the entry.
The protocol changes to IMAP described below allow a client to access
or change the values of any attributes in any entries in a message
annotation, assuming it has sufficient access rights to do so (see
Section 4.4 for specifics).
4.2. Namespace of entries and attributes
A message may contain zero or more annotations, each of which is a
single uniquely named entry. Each entry has a hierarchical name,
with each component of the name separated by a slash ("/"). An entry
name MUST NOT contain two consecutive "/" characters and MUST NOT end
with a "/" character.
Each entry is made up of a set of attributes. Each attribute has a
Daboo & Gellens Expires February 2, 2007 [Page 9]
Internet-Draft IMAP ANNOTATE Extension August 2006
hierarchical name, with each component of the name separated by a
period ("."). An attribute name MUST NOT contain two consecutive "."
characters and MUST NOT end with a "." character.
The value of an attribute is "NIL" (has no value), or is a string of
zero or more octets.
Entry and attribute names MUST NOT contain asterisk ("*") or percent
("%") characters and MUST NOT contain non-ASCII characters or the
NULL octet. Invalid entry or attribute names result in a BAD
response in any IMAP commands where they are used.
Attribute names MUST NOT contain any hierarchical components with the
names "priv" or "shared" as those have special meaning (see
Section 4.3).
Entry and attribute names are case-sensitive.
Use of control or punctuation characters in entry and attribute names
is strongly discouraged.
This specification defines an initial set of entry and attribute
names available for use in message annotations. In addition, an
extension mechanism is described to allow additional names to be
added as needed.
4.2.1. Entry Names
Entry names MUST be specified in a standards track or IESG approved
experimental RFC, or fall under the vendor namespace. See
Section 7.1 for the registration template.
/
Defines the top-level of entries associated with an entire
message. This entry itself does not contain any attributes. All
entries that start with a numeric character ("0" - "9") refer to
an annotation on a specific body part. All other entries are for
annotations on the entire message.
/comment
Defines a comment or note associated with an entire message.
/flags
This entry hierarchy is reserved for future use.
/altsubject
Daboo & Gellens Expires February 2, 2007 [Page 10]
Internet-Draft IMAP ANNOTATE Extension August 2006
Contains text supplied by the message recipient, to be used by the
client instead of the original message Subject.
/vendor/<vendor-token>
Defines the top-level of entries associated with an entire message
as created by a particular product of some vendor. These sub-
entries can be used by vendors to provide client-specific
annotations. The vendor-token MUST be registered with IANA, using
the [RFC2244] vendor subtree registry.
/<section-part>
Defines the top-level of entries associated with a specific body
part of a message. This entry itself does not contain any
attributes. The section-part is a numeric part specifier. Its
syntax is the same as the section-part ABNF element defined in
[RFC3501]. The server MUST return a BAD response if the client
uses an incorrect part specifier (either incorrect syntax or a
specifier referring to a non-existent part). The server MUST
return a BAD response if the client uses an empty part specifier
(which is used in IMAP to represent the entire message).
/<section-part>/comment
Defines a comment or note associated with a specific body part of
a message.
/<section-part>/flags
Defines the top-level of entries associated with flag state for a
specific body part of a message. All sub-entries are maintained
entirely by the client. There is no implicit change to any flag
by the server.
/<section-part>/flags/seen
This is similar to the IMAP \Seen flag except it applies to
only the body part referenced by the entry.
/<section-part>/flags/answered
This is similar to the IMAP \Answered flag except it applies
to only the body part referenced by the entry.
/<section-part>/flags/flagged
This is similar to the IMAP \Flagged flag except it 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"
attribute of each of the entries described above must be either
"1", "0" or "NIL". "1" corresponds to the flag being set.
Daboo & Gellens Expires February 2, 2007 [Page 11]
Internet-Draft IMAP ANNOTATE Extension August 2006
/<section-part>/vendor/<vendor-token>
Defines the top-level of entries associated with a specific body
part of a message as created by a particular product of some
vendor. This entry can be used by vendors to provide client
specific annotations. The vendor-token MUST be registered with
IANA.
4.2.2. Attribute Names
Attribute names MUST be specified in a standards track or IESG
approved experimental RFC. See Section 7.1 for the registration
template.
All attribute names implicitly have a ".priv" and a ".shared" suffix
which maps to private and shared versions of the entry. Searching or
fetching without using either suffix includes both. The client MUST
specify either a ".priv" or ".shared" suffix when storing an
annotation or sorting on annotations.
value
A string or binary data representing the value of the annotation.
To delete an annotation, the client can store "NIL" into the
value. If the client requests the value attribute for a non-
existent entry, then the server MUST return "NIL" for the value.
The content represented by the string is determined by the
content-type used to register the entry (see Section 7.1 for entry
registration templates). Where applicable, the registered
content-type MUST include a charset parameter. Text values SHOULD
use the utf-8 [RFC3629] character set.
Note that binary data (data which may contain the NULL octet) is
allowed (e.g. for storing images etc), and this extension uses the
"literal8" syntax element [RFC4466] to allow such data to be
written to or read from the server.
size
The size of the value, in octets. Set automatically by the
server, read-only to clients. If the client requests the size
attribute for a non-existent entry, then the server MUST return
"0" (zero) for the size.
4.3. Private versus Shared
Some IMAP mailboxes are private, accessible only to the owning user.
Other mailboxes are not, either because the owner has set an ACL
[RFC4314] which permits access by other users, or because it is a
shared mailbox.
This raises the issue of shared versus private annotations.
Daboo & Gellens Expires February 2, 2007 [Page 12]
Internet-Draft IMAP ANNOTATE Extension August 2006
If all annotations are private, it is impossible to set annotations
in a shared or otherwise non-private mailbox that are visible to
other users. This eliminates what could be a useful aspect of
annotations in a shared environment. An example of such use is a
shared IMAP folder containing bug reports. Engineers may want to use
annotations to add information to existing messages, indicate
assignments, status, etc. This use requires shared annotations.
If all annotations are shared, it is impossible to use annotations
for private notes on messages in shared mailboxes. Also, modifying
an ACL to permit access to a mailbox by other users may
unintentionally expose private information.
There are also situations in which both shared and private
annotations are useful. For example, an administrator may want to
set shared annotations on messages in a shared folder, which
individual users may wish to supplement with additional notes.
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
client to access both and not overlook either. There is also a
danger in allowing a client to store an annotation without knowing if
it is shared or private.
This document proposes two standard suffixes for all attributes:
".shared" and ".priv". A SEARCH or FETCH command which specifies
neither uses both. STORE, APPEND and SORT commands MUST explicitly
use ".priv" or ".shared" suffixes.
If the ANNOTATE extension is present, support for shared annotations
in servers is REQUIRED, whilst support for private annotations in
servers is OPTIONAL. This recognizes the fact that support for
private annotations may introduce significantly more complexity to a
server in terms of tracking ownership of the annotations, how quota
is determined for users based on their own annotations etc. Clients
that support the ANNOTATE extension MUST handle both shared and
private annotations.
4.4. Access Control
A user needs to have appropriate rights in order to read or write
".priv" or ".shared" annotation values. How those rights are
calculated depends on whether the ACL [RFC2086] extension or its
update [RFC4314] is present or not. If a client attempts to store or
fetch an annotation to which they do not have the appropriate rights,
the server MUST respond with a NO response.
When the ACL extension is not present, access to annotation values is
Daboo & Gellens Expires February 2, 2007 [Page 13]
Internet-Draft IMAP ANNOTATE Extension August 2006
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
mode.
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
itself.
The "r" right controls both read and write access to ".priv"
annotation values. When it is on, access to ".priv" annotations is
allowed, when it is off, access to ".priv" annotations is disallowed.
The "r" right controls only the read access for ".shared" annotation
values. When it is on, ".shared" annotations can be read, when it is
off, ".shared" annotations cannot be read.
The "n" right controls only the write access for ".shared" annotation
values. When it is on, ".shared" annotations can be changed or
created through either a STORE or APPEND command, when it is off,
".shared" annotations cannot be changed or created. The "n" right
constitutes a "shared flag right" as defined in [RFC4314] Section
6.2.
A summary of all the access control restrictions is tabulated below
Daboo & Gellens Expires February 2, 2007 [Page 14]
Internet-Draft IMAP ANNOTATE Extension August 2006
+---------------+---------------+-----------------------------------+
| Server Type | Action on | Type of mailbox |
| | annotation | |
+===============+===============+===================================+
| | | |
| | read .priv | Any mailbox that can be SELECTED |
| | values | or EXAMINED. |
| | | |
| +---------------+-----------------------------------+
| | | |
| | write .priv | Any SELECTED [READ-WRITE] mailbox.|
| | values | SELECTED [READ-ONLY] mailboxes MAY|
| Server | | also permit writes. |
| without | | |
| ACL Extension +---------------+-----------------------------------+
| | | |
| | read .shared | Any mailbox that can be SELECTED |
| | values | or EXAMINED. |
| | | |
| +---------------+-----------------------------------+
| | | |
| | write .shared | Any mailbox that can be SELECTED |
| | values | or EXAMINED and is [READ-WRITE]. |
| | | |
+---------------+---------------+-----------------------------------+
| | | |
| | read .priv | Any mailbox with the "r" |
| | values | ACL right. |
| | | |
| +---------------+-----------------------------------+
| | | |
| | write .priv | Any mailbox with the "r" |
| Server | values | ACL right. |
| with | | |
| ACL Extension +---------------+-----------------------------------+
| | | |
| | read .shared | Any mailbox with the "r" |
| | values | ACL right. |
| | | |
| +---------------+-----------------------------------+
| | | |
| | write .shared | Any mailbox with the "n" |
| | values | ACL right. |
| | | |
+---------------+---------------+-----------------------------------+
Daboo & Gellens Expires February 2, 2007 [Page 15]
Internet-Draft IMAP ANNOTATE Extension August 2006
4.5. Access to Standard IMAP Flags and Keywords
Due to ambiguity of how private and shared values would map to the
base IMAP flag and keyword values, the ANNOTATE extension does not
expose IMAP flags or keywords as entries. However, the /flags
annotation entry is reserved for future use and MUST NOT be used by
clients or servers supporting this extension.
Clients that need to implement shared and private "flags" can create
their own annotation entries for those, completely bypassing the base
IMAP flag/keyword behavior.
5. IMAP Protocol Changes
5.1. General Considerations
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
know what level of support is available. Servers MUST return an
ANNOTATIONS response code during the SELECT or EXAMINE command for a
mailbox to indicate the level of support. Possible data items used
with the ANNOTATIONS response code are:
"NONE" - this indicates that the mailbox being selected does not
support annotations at all. Clients MUST NOT attempt to use
annotation extensions in commands.
"READ-ONLY" - this indicates that the annotations supported by the
mailbox cannot be changed by the client. Clients MUST NOT attempt
to store annotations on any messages in a mailbox with this
response code.
"NOPRIVATE" - this indicates that the server does not support
private annotations on the mailbox. Only shared annotations are
supported. Clients SHOULD only attempt to read or store
annotations attributes with the ".shared" suffix. If a client
uses an attribute with the ".priv" suffix in a FETCH command, then
servers should return the attribute value in the FETCH response as
"NIL". If a client uses an attribute with the ".priv" suffix in a
STORE command (or an APPEND command targeted at the mailbox) then
the server MUST return a NO response.
numeric values - if servers support writable annotations, then the
server MUST indicate the maximum size for an annotation value by
providing the maximum size value in the response code. Clients
MUST NOT store annotation values of a size greater than the amount
indicated by the server. Servers MUST accept a minimum annotation
Daboo & Gellens Expires February 2, 2007 [Page 16]
Internet-Draft IMAP ANNOTATE Extension August 2006
data size of at least 1024 bytes if annotations can be written.
In addition the server MAY limit the total number of annotations for
a single message. However, the server MUST provide a minimum
annotation count per message of at least 10.
5.2. ANNOTATE parameter with the SELECT/EXAMINE commands
The ANNOTATE extension defines a single optional SELECT parameter
[RFC4466] "ANNOTATE", which is used to turn on unsolicited responses
for annotations as described in Section 5.4. This optional parameter
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
whether it was used in a previous SELECT/EXAMINE during the same
session.
Example:
C: a SELECT INBOX (ANNOTATE)
S: * FLAGS (\Answered \Flagged \Draft \Deleted \Seen)
S: * OK [PERMANENTFLAGS (\Answered \Flagged \Draft
\Deleted \Seen \*)]
S: * 10268 EXISTS
S: * 1 RECENT
S: * OK [UNSEEN 10268]
S: * OK [UIDVALIDITY 890061587]
S: * OK [UIDNEXT 34643]
S: * OK [ANNOTATIONS 20480 NOPRIVATE]
S: a OK [READ-WRITE] Completed
In the above example, a SELECT command with the ANNOTATE parameter
is issued. The response from the server includes the required
ANNOTATIONS response that indicates that the server supports
annotations up to a maximum size of 20480 bytes and does not
support private annotations (only shared).
5.3. ANNOTATION Message Data Item in FETCH Command
This extension adds an ANNOTATION message data item to the FETCH
command. This allows clients to retrieve annotations for a range of
messages in the currently selected mailbox.
ANNOTATION <entry-specifier> <attribute-specifier>
The ANNOTATION message data item, when used by the client in the
FETCH command, takes an entry specifier and an attribute
specifier.
Daboo & Gellens Expires February 2, 2007 [Page 17]
Internet-Draft IMAP ANNOTATE Extension August 2006
Example:
C: a FETCH 1 (ANNOTATION (/comment value))
S: * 1 FETCH (ANNOTATION (/comment
(value.priv "My comment"
value.shared "Group note")))
S: a OK Fetch complete
In the above example, the content of the "value" attribute for the
"/comment" entry is requested by the client and returned by the
server. Since neither ".shared" nor ".priv" was specified, both
are returned.
"*" and "%" wild card characters can be used in entry specifiers to
match one or more characters at that position, with the exception
that "%" does not match the "/" hierarchy delimiter. Thus an entry
specifier of "/%" matches entries such as "/comment" and
"/altsubject", but not "/1/comment".
Example:
C: a UID FETCH 1123 (UID ANNOTATION
(/* (value.priv size.priv)))
S: * 12 FETCH (UID 1123 ANNOTATION
(/comment (value.priv "My comment"
size.priv "10")
/altsubject (value.priv "Rhinoceroses!"
size.priv "13")
/vendor/foobar/label.priv
(value.priv "label43"
size.priv "7")
/vendor/foobar/personality
(value.priv "Tallulah Bankhead"
size.priv "17")))
S: a OK Fetch complete
In the above example, the contents of the private "value" and
"size" attributes for any entries in the "/" hierarchy are
requested by the client and returned by the server.
Example:
C: a FETCH 1 (ANNOTATION (/% value.shared))
S: * 1 FETCH (ANNOTATION
(/comment (value.shared "Patch Mangler")
/altsubject (value.shared "Patches? We don't
need no steenkin patches!")))
S: a OK Fetch complete
Daboo & Gellens Expires February 2, 2007 [Page 18]
Internet-Draft IMAP ANNOTATE Extension August 2006
In the above example, the contents of the shared "value"
attributes for entries at the top level only of the "/" hierarchy
are requested by the client and returned by the server.
Entry and attribute specifiers can be lists of atomic specifiers, so
that multiple items of each type may be returned in a single FETCH
command.
Example:
C: a FETCH 1 (ANNOTATION
((/comment /altsubject) value.priv))
S: * 1 FETCH (ANNOTATION
(/comment (value.priv "What a chowder-head")
/altsubject (value.priv "How to crush beer cans")))
S: a OK Fetch complete
In the above example, the contents of the private "value"
attributes for the two entries "/comment" and "/altsubject" are
requested by the client and returned by the server.
5.4. ANNOTATION Message Data Item in FETCH Response
The ANNOTATION message data item in the FETCH response displays
information about annotations in a message.
ANNOTATION parenthesized list
The response consists of a list of entries, each of which has a
list of attribute-value pairs.
Example:
C: a FETCH 1 (ANNOTATION (/comment value))
S: * 1 FETCH (ANNOTATION (/comment
(value.priv "My comment"
value.shared NIL)))
S: a OK Fetch complete
In the above example, a single entry with a single attribute-value
pair is returned by the server. Since the client did not specify
a ".shared" or ".priv" suffix, both are returned. Only the
private attribute has a value (the shared value is "NIL").
Example:
Daboo & Gellens Expires February 2, 2007 [Page 19]
Internet-Draft IMAP ANNOTATE Extension August 2006
C: a FETCH 1 (ANNOTATION
((/comment /altsubject) value))
S: * 1 FETCH (ANNOTATION
(/comment (value.priv "My comment"
value.shared NIL)
/altsubject (value.priv "My subject"
value.shared NIL)))
S: a OK Fetch complete
In the above example, two entries each with a single attribute-
value pair are returned by the server. Since the client did not
specify a ".shared" or ".priv" suffix, both are returned. Only
the private attributes have values; the shared attributes are
"NIL".
Example:
C: a FETCH 1 (ANNOTATION
(/comment (value size)))
S: * 1 FETCH (ANNOTATION
(/comment
(value.priv "My comment"
value.shared NIL
size.priv "10"
size.shared "0")))
S: a OK Fetch complete
In the above example, a single entry with two attribute-value
pairs is returned by the server. Since the client did not specify
a ".shared" or ".priv" suffix, both are returned. Only the
private attributes have values; the shared attributes are "NIL".
Servers SHOULD send ANNOTATION message data items in unsolicited
FETCH responses if an annotation entry is changed by a third-party,
and the ANNOTATE select parameter was used. This allows servers to
keep clients updated with changes to annotations by other clients.
Unsolicited ANNOTATION responses MUST NOT include ANNOTATION data
values - only the entry name of the ANNOTATION that has changed.
This restriction avoids sending ANNOTATION data values (which may be
large) to a client unless the client explicitly asks for the value.
Example:
C: a STORE 1 +FLAGS (\Seen)
S: * 1 FETCH (FLAGS (\Seen))
ANNOTATION (/comment))
S: a OK STORE complete
Daboo & Gellens Expires February 2, 2007 [Page 20]
Internet-Draft IMAP ANNOTATE Extension August 2006
In the above example, an unsolicited ANNOTATION response is
returned during a STORE command. The unsolicited response
contains only the entry name of the annotation that changed, and
not its value.
5.5. ANNOTATION Message Data Item in STORE
ANNOTATION <parenthesized entry-attribute-value list>
Sets the specified list of entries by adding or replacing the
specified attributes with the values provided. Clients can use
"NIL" for values of attributes it wants to remove from entries.
The ANNOTATION message data item used with the STORE command has an
implicit ".SILENT" behavior. This means the server does not generate
an untagged FETCH in response to the STORE command and assumes that
the client updates its own cache if the command succeeds. Though
note, that if the Conditional STORE extension [RFC4551] is present,
then an untagged FETCH response with a MODSEQ data item will be
returned by the server as required by [RFC4551].
If the server is unable to store an annotation because the size of
its value is too large, the server MUST return a tagged NO response
with a "[ANNOTATE TOOBIG]" response code.
If the server is unable to store a new annotation because the maximum
number of allowed annotations has already been reached, the server
MUST return a tagged NO response with a "[ANNOTATE TOOMANY]" response
code.
Example:
C: a STORE 1 ANNOTATION (/comment
(value.priv "My new comment"))
S: a OK Store complete
In the above example, the entry "/comment" is created (if not
already present) and the private attribute "value" with data set
to "My new comment" is created if not already present, or replaced
if it exists.
Example:
C: a STORE 1 ANNOTATION (/comment
(value.shared NIL))
S: a OK Store complete
Daboo & Gellens Expires February 2, 2007 [Page 21]
Internet-Draft IMAP ANNOTATE Extension August 2006
In the above example, the shared "value" attribute of the entry
"/comment" is removed by storing "NIL" into the attribute.
Multiple entries can be set in a single STORE command by listing
entry-attribute-value pairs in the list.
Example:
C: a STORE 1 ANNOTATION (/comment
(value.priv "Get tix Tuesday")
/altsubject
(value.priv "Wots On"))
S: a OK Store complete
In the above example, the entries "/comment" and "/altsubject" are
created (if not already present) and the private attribute "value"
is created for each entry if not already present, or replaced if
they exist.
Multiple attributes can be set in a single STORE command by listing
multiple attribute-value pairs in the entry list.
Example:
C: a STORE 1 ANNOTATION (/comment
(value.priv "My new comment"
value.shared "foo's bar"))
S: a OK Store complete
In the above example, the entry "/comment" is created (if not already
present) and the private and shared "value" attributes are created if
not already present, or replaced if they exist.
5.6. ANNOTATION interaction with COPY
The COPY command can be used to move messages from one mailbox to
another on the same server. Servers that support the ANNOTATION
extension MUST, for each message being copied, copy all ".priv"
annotation data for the current user only, and all ".shared"
annotation data along with the message to the new mailbox. The only
exceptions to this are if the destination mailbox permissions are
such that either the ".priv" or ".shared" annotations are not
allowed, or if the destination mailbox is of a type that does not
support annotations or does not support storing of annotations (a
mailbox that returns a "NONE" or "READ-ONLY" response code in its
ANNOTATIONS response), or if the destination mailbox cannot support
the size of a annotation because it exceeds the ANNOTATIONS value.
Servers MUST NOT copy ".priv" annotation data for users other than
Daboo & Gellens Expires February 2, 2007 [Page 22]
Internet-Draft IMAP ANNOTATE Extension August 2006
the current user.
5.7. ANNOTATION Message Data Item in APPEND
ANNOTATION <parenthesized entry-attribute-value list>
Sets the specified list of entries and attributes in the resulting
message.
The APPEND command can include annotations for the message being
appended via the addition of a new append data item [RFC4466]. The
new data item can also be used with the multi-append [RFC3502]
extension that allows multiple messages to be appended via a single
APPEND command.
Example:
C: a APPEND drafts ANNOTATION (/comment
(value.priv "Don't send until I say so")) {310}
S: + Ready for literal data
C: MIME-Version: 1.0
...
C:
S: a OK APPEND completed
In the above example, a comment with a private value is added to a
new message appended to the mailbox. The ellipsis represents the
bulk of the message.
5.8. ANNOTATION Criterion in SEARCH
ANNOTATION <entry-name> <attribute-name> <value>
The ANNOTATION criterion for the SEARCH command allows a client to
search for a specified string in the value of an annotation entry of
a message.
Messages that have annotations with entries matching <entry-name> and
attributes matching <attribute-name> and the specified string <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
those items. The "%" character can be used in the entry name field
to match a single level of hierarchy only.
Only the "value", "value.priv" and "value.shared" attributes can be
searched. Clients MUST NOT specify an attribute other than either
"value", "value.priv" or "value.shared". Servers MUST return a BAD
response if the client tries to search any other attribute.
Daboo & Gellens Expires February 2, 2007 [Page 23]
Internet-Draft IMAP ANNOTATE Extension August 2006
Example:
C: a SEARCH ANNOTATION /comment value "IMAP4"
S: * SEARCH 2 3 5 7 11 13 17 19 23
S: a OK Search complete
In the above example, the message numbers of any messages
containing the string "IMAP4" in the shared or private "value"
attribute of the "/comment" entry are returned in the search
results.
Example:
C: a SEARCH ANNOTATION * value.priv "IMAP4"
S: * SEARCH 1 2 3 5 8 13 21 34
S: a OK Search complete
In the above example, the message numbers of any messages
containing the string "IMAP4" in the private "value" attribute of
any entry are returned in the search results.
5.9. ANNOTATION Key in SORT
ANNOTATION <entry-name> <attribute-name>
The ANNOTATION criterion for the SORT command [I-D.ietf-imapext-sort]
instructs the server to return the message numbers or UIDs of a
mailbox, sorted using the values of the specified annotations. The
ANNOTATION criterion is available if the server returns both
ANNOTATE-EXPERIMENT-1 and SORT as supported capabilities in the
CAPABILITY command response.
Messages are sorted using the values of the <attribute-name>
attributes in the <entry-name> entries.
Clients MUST provide either the ".priv" or ".shared" suffix to the
attribute name to ensure that the server knows which specific value
to sort on.
Only the "value.priv" and "value.shared" attributes can be used for
sorting. Clients MUST NOT specify an attribute other than either
"value.priv" or "value.shared". Servers MUST return a BAD response
if the client tries to sort on any other attribute.
When either "value.priv" or "value.shared" is being sorted, the
server MUST use the character set value specified in the SORT command
to determine the appropriate sort order.
Daboo & Gellens Expires February 2, 2007 [Page 24]
Internet-Draft IMAP ANNOTATE Extension August 2006
Example:
C: a SORT (ANNOTATION /altsubject value.shared) UTF-8 ALL
S: * SORT 2 3 4 5 1 11 10 6 7 9 8
S: a OK Sort complete
In the above example, the message numbers of all messages are
returned, sorted according to the shared "value" attribute of the
"/altsubject" entry.
Note that the ANNOTATION sort key must include a fully specified
entry - wild cards are not allowed.
5.10. New ACL Rights
As discussed in Section 4.4 this extension adds a new "n" right to
the list of rights provided by the ACL extensions [RFC2086] and
[RFC4314].
6. Formal Syntax
The following syntax specification uses the Augmented Backus-Naur
Form (ABNF) notation as specified in [RFC2234].
Non-terminals referenced but not defined below are as defined by
[RFC3501] with the new definitions in [RFC4466] superseding those in
[RFC3501].
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.
ann-size = "NONE" /
(("READ-ONLY" / nz-size)
[SP "NOPRIVATE"])
; response codes indicating the level of
; support for annotations in a mailbox
append-ext =/ att-annotate
; modifies [RFC3501] extension behaviour
att-annotate = "ANNOTATION" SP
"(" entry-att *(SP entry-att) ")"
att-search = "value" / "value.priv" / "value.shared"
; the only attributes that can be searched
Daboo & Gellens Expires February 2, 2007 [Page 25]
Internet-Draft IMAP ANNOTATE Extension August 2006
att-sort = "value.priv" / "value.shared"
; the only attributes that can be sorted
att-value = attrib SP value
attrib = astring
; dot-separated attribute name
; MUST NOT contain "*" or "%"
attribs = attrib / "(" attrib *(SP attrib) ")"
; one or more attribute specifiers
capability =/ "ANNOTATE-EXPERIMENT-1"
; defines the capability for this extension
entries = entry-match /
"(" entry-match *(SP entry-match) ")"
entry = astring
; slash-separated path to entry
; MUST NOT contain "*" or "%"
entry-att = entry SP "(" att-value *(SP att-value) ")"
entry-match = list-mailbox
; slash-separated path to entry
; MAY contain "*" or "%" for use as wild cards
fetch-att =/ "ANNOTATION" SP "(" entries SP attribs ")"
; modifies original IMAP fetch-att
msg-att-dynamic =/ "ANNOTATION" SP
( "(" entry-att *(SP entry-att) ")" /
"(" entry *(SP entry) ")" )
; extends FETCH response with annotation data
resp-text-code =/ "ANNOTATE" SP "TOOBIG" /
"ANNOTATE" SP "TOOMANY" /
"ANNOTATIONS" SP ann-size
; new response codes
search-key =/ "ANNOTATION" SP entry-match SP att-search
SP value
; modifies original IMAP search-key
select-param =/ "ANNOTATE"
; defines the select parameter used with
; ANNOTATE extension
Daboo & Gellens Expires February 2, 2007 [Page 26]
Internet-Draft IMAP ANNOTATE Extension August 2006
sort-key =/ "ANNOTATION" SP entry SP att-sort
; modifies original sort-key
store-att-flags =/ att-annotate
; modifies original IMAP STORE command
value = nstring / literal8
7. IANA Considerations
Entry names MUST be specified in a standards track or IESG approved
experimental RFC, or fall under the vendor namespace. Vendor names
MUST be registered.
Attribute names MUST be specified in a standards track or IESG
approved experimental RFC.
Each entry registration MUST include a content-type that is used to
indicate the nature of the annotation value. Where applicable a
charset parameter MUST be included with the content-type.
7.1. Entry and Attribute Registration Template
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[] Entry [] Attribute
Name: ______________________________
Description: _______________________
____________________________________
____________________________________
Content-Type:_______________________
Contact person: ____________________
email: ____________________
Daboo & Gellens Expires February 2, 2007 [Page 27]
Internet-Draft IMAP ANNOTATE Extension August 2006
7.2. Entry Registrations
The following templates specify the IANA registrations of annotation
entries specified in this document.
7.2.1. /comment
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[X] Entry [] Attribute
Name: /comment
Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo
email: cyrus@daboo.name
7.2.2. /flags
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[X] Entry [] Attribute
Name: /flags
Description: Reserved entry hierarchy.
Content-Type: -
Contact person: Cyrus Daboo
email: cyrus@daboo.name
Daboo & Gellens Expires February 2, 2007 [Page 28]
Internet-Draft IMAP ANNOTATE Extension August 2006
7.2.3. /altsubject
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[X] Entry [] Attribute
Name: /altsubject
Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo
email: cyrus@daboo.name
7.2.4. /<section-part>/comment
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[X] Entry [] Attribute
Name: /<section-part>/comment
Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo
email: cyrus@daboo.name
Daboo & Gellens Expires February 2, 2007 [Page 29]
Internet-Draft IMAP ANNOTATE Extension August 2006
7.2.5. /<section-part>/flags/seen
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[X] Entry [] Attribute
Name: /<section-part>/flags/seen
Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo
email: cyrus@daboo.name
7.2.6. /<section-part>/flags/answered
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[X] Entry [] Attribute
Name: /<section-part>/flags/answered
Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo
email: cyrus@daboo.name
Daboo & Gellens Expires February 2, 2007 [Page 30]
Internet-Draft IMAP ANNOTATE Extension August 2006
7.2.7. /<section-part>/flags/flagged
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[X] Entry [] Attribute
Name: /<section-part>/flags/flagged
Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo
email: cyrus@daboo.name
7.2.8. /<section-part>/flags/forwarded
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[X] Entry [] Attribute
Name: /<section-part>/flags/forwarded
Description: Defined in IMAP ANNOTATE extension document.
Content-Type: text/plain; charset=utf-8
Contact person: Cyrus Daboo
email: cyrus@daboo.name
7.3. Attribute Registrations
The following templates specify the IANA registrations of annotation
attributes specified in this document.
Daboo & Gellens Expires February 2, 2007 [Page 31]
Internet-Draft IMAP ANNOTATE Extension August 2006
7.3.1. value
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[] Entry [X] Attribute
Name: value
Description: Defined in IMAP ANNOTATE extension document.
Contact person: Cyrus Daboo
email: cyrus@daboo.name
7.3.2. size
To: iana@iana.org
Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item:
[] Entry [X] Attribute
Name: size
Description: Defined in IMAP ANNOTATE extension document.
Contact person: Cyrus Daboo
email: cyrus@daboo.name
8. Internationalization Considerations
Annotations may contain values that include text strings, and both
searching and sorting are possible with annotations. Servers MUST
follow standard IMAP text normalization, character set conversion and
collation rules when such operations are carried out, as they would
for other textual fields being searched or sorted on.
9. Security Considerations
Annotations whose values are intended to remain private MUST be
stored in ".priv" values, and not ".shared" values which may be
Daboo & Gellens Expires February 2, 2007 [Page 32]
Internet-Draft IMAP ANNOTATE Extension August 2006
accessible to other users.
Excluding the above issues the ANNOTATE extension does not raise any
security considerations that are not present in the base IMAP
protocol, and these issues are discussed in [RFC3501].
10. References
10.1. Normative References
[I-D.ietf-imapext-sort]
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.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
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
Configuration Access Protocol", RFC 2244, November 1997.
[RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION
4rev1", RFC 3501, March 2003.
[RFC3502] Crispin, M., "Internet Message Access Protocol (IMAP) -
MULTIAPPEND Extension", RFC 3502, March 2003.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, November 2003.
[RFC4314] Melnikov, A., "IMAP4 Access Control List (ACL) Extension",
RFC 4314, December 2005.
[RFC4466] Melnikov, A. and C. Daboo, "Collected Extensions to IMAP4
ABNF", RFC 4466, April 2006.
10.2. Informative References
[RFC4551] Melnikov, A. and S. Hole, "IMAP Extension for Conditional
STORE Operation or Quick Flag Changes Resynchronization",
RFC 4551, June 2006.
Daboo & Gellens Expires February 2, 2007 [Page 33]
Internet-Draft IMAP ANNOTATE Extension August 2006
Appendix A. Acknowledgments
Many thanks to Chris Newman for his detailed comments on the first
draft of this document, and to the participants at the ACAP working
dinner in Pittsburgh. The participants of the IMAPext working group
made significant contributions to this work.
Authors' Addresses
Cyrus Daboo
Apple Computer, Inc.
1 Infinite Loop
Cupertino, CA 95014
USA
Email: cyrus@daboo.name
URI: http://www.apple.com/
Randall Gellens
QUALCOMM Incorporated
5775 Morehouse Dr.
San Diego, CA 92121-2779
US
Email: randy@qualcomm.com
Daboo & Gellens Expires February 2, 2007 [Page 34]
Internet-Draft IMAP ANNOTATE Extension August 2006
Full Copyright Statement
Copyright (C) The Internet Society (2006).
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
retain all their rights.
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
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
made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be
found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
ietf-ipr@ietf.org.
Acknowledgment
Funding for the RFC Editor function is provided by the IETF
Administrative Support Activity (IASA).
Daboo & Gellens Expires February 2, 2007 [Page 35]
