Network Working Group A. Melnikov
Internet-Draft Isode Ltd
Expires: December 19, 2006 June 17, 2006
Lemonade Inband Notifications
draft-melnikov-lemonade-imap-events-00.txt
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 December 19, 2006.
Copyright Notice
Copyright (C) The Internet Society (2006).
Abstract
This document specifies how Internet Message Store Events can be
represented as IMAP (RFC 3501) untagged responses.
Melnikov Expires December 19, 2006 [Page 1]
Internet-Draft Lemonade Inband Notifications June 2006
Table of Contents
1. Requirements notation . . . . . . . . . . . . . . . . . . . . . 3
2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Mapping of Internet Message Store Events to IMAP responses . . 3
3.1. Message Addition and Deletion for the currently
selected mailbox . . . . . . . . . . . . . . . . . . . . . 3
3.2. Message Addition and Deletion for other mailboxes . . . . . 4
3.3. Message Flags events for the currently selected mailbox . . 4
3.4. Message Flags events for other mailboxes . . . . . . . . . 5
3.5. Access Accounting events . . . . . . . . . . . . . . . . . 5
3.6. Mailbox management events . . . . . . . . . . . . . . . . . 5
4. Security Considerations . . . . . . . . . . . . . . . . . . . . 5
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 5
6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 5
6.1. Normative References . . . . . . . . . . . . . . . . . . . 5
6.2. Informative References . . . . . . . . . . . . . . . . . . 6
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 7
Intellectual Property and Copyright Statements . . . . . . . . . . 8
Melnikov Expires December 19, 2006 [Page 2]
Internet-Draft Lemonade Inband Notifications June 2006
1. Requirements notation
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].
In examples, "C:" and "S:" indicate lines sent by the client and
server respectively. If a single "C:" or "S:" label applies to
multiple lines, then the line breaks between those lines are for
editorial clarity only and are not part of the actual protocol
exchange.
2. Introduction
IMAP [IDLE] extension defines how an IMAP [RFC3501] server can push
notifications to an IMAP client. This mechanism is suitable for
transporting of Internet Message Store events [MSGEVENTS] "inband".
However the [IDLE] extension doesn't provide any guidance on how
different Message Store events can be represented in IMAP. This
document is attempting to fill this gap.
3. Mapping of Internet Message Store Events to IMAP responses
[[anchor4: Note that some event types require that the server
supports certain IMAP extensions (e.g. QUOTA).]]
3.1. Message Addition and Deletion for the currently selected mailbox
An AppendMessage or NewMessage event related to one or more messages
in the currently selected mailbox (if any) MUST be reported as an
EXISTS response. The server MAY also send a RECENT response, if the
server would mark the message as \Recent. [[anchor6: This doesn't
provide UID of the new message.]] If the bodyStructure parameter is
included in the event, it MUST be returned in a FETCH response
containing the BODYSTRUCTURE FETCH item. If the FETCH response is
returned it MUST contain the UID FETCH item.
Note that a single EXISTS response can be returned for multiple
AppendMessage/NewMessage events.
Melnikov Expires December 19, 2006 [Page 3]
Internet-Draft Lemonade Inband Notifications June 2006
Example:
S: * 161 EXISTS
S: * 161 FETCH (UID 25627 BODYSTRUCTURE (("TEXT" "PLAIN"
("CHARSET" "US-ASCII") NIL NIL "7BIT" 1152 23)(
"TEXT" "PLAIN" ("CHARSET" "US-ASCII" "NAME"
"trip.txt")
"<960723163407.20117h@washington.example.com>"
"Your trip details" "BASE64" 4554 73) "MIXED"))
Example:
S: * 162 EXISTS
S: * 4 RECENT
An ExpireMessage or ExpungeMessage event related to a message in the
currently selected mailbox MUST be reported as an EXPUNGE response.
[[anchor7: Recommend the EXPUNGED response?]]
[[anchor8: OverQuota - Use OVERQUOTA response code defined in the
expired draft-cridland-imap-quota-xx.txt.]]
[[anchor9: UnderQuota - TBD]]
3.2. Message Addition and Deletion for other mailboxes
An AppendMessage/NewMessage/ExpireMessage/ExpungeMessage event
related to one or more messages in any mailbox rather then the
currently selected one MUST result in an untagged STATUS response,
containing MESSAGES status data item. Other status data items MAY be
included. [[anchor11: What about UIDVALIDITY status item?]]
Example:
S: * STATUS blurdybloop (MESSAGES 231 RECENT 8
UIDVALIDITY 765)
[[anchor12: OverQuota - TBD]]
[[anchor13: UnderQuota - TBD]]
3.3. Message Flags events for the currently selected mailbox
All message flag events related to one or more messages in the
currently selected mailbox (if any) MUST be reported as a FETCH
response containing FLAGS and UID fetch items.
Melnikov Expires December 19, 2006 [Page 4]
Internet-Draft Lemonade Inband Notifications June 2006
3.4. Message Flags events for other mailboxes
[[anchor16: TBD]]
3.5. Access Accounting events
[[anchor18: TBD]]
3.6. Mailbox management events
[[anchor20: These events are not currently defined in MSGEVENTS.]]
Mailbox creation MUST be reported as a LIST response, containing
mailbox attributes which are usually returned in a LIST response.
Mailbox deletion MUST be reported as a LIST response, containing
\NonExistent mailbox attribute [LISTEXT].
Mailbox rename - TBD. [[anchor21: This would require a new LIST
extended data item.]]
4. Security Considerations
[[anchor23: TBD]]
5. IANA Considerations
This document doesn't require any action from IANA.
6. References
6.1. Normative References
[LISTEXT] Leiba, B. and A. Melnikov, "IMAP4 LIST Command
Extensions", April 2006.
[MSGEVENTS]
Newman, C., "Internet Message Store Events", June 2006.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION
4rev1", RFC 3501, March 2003.
Melnikov Expires December 19, 2006 [Page 5]
Internet-Draft Lemonade Inband Notifications June 2006
6.2. Informative References
[IDLE] Leiba, B., "IMAP4 IDLE Command", RFC 2177, June 1997.
Melnikov Expires December 19, 2006 [Page 6]
Internet-Draft Lemonade Inband Notifications June 2006
Author's Address
Alexey Melnikov
Isode Ltd
5 Castle Business Village
36 Station Road
Hampton, Middlesex TW12 2BX
UK
Email: Alexey.Melnikov@isode.com
Melnikov Expires December 19, 2006 [Page 7]
Internet-Draft Lemonade Inband Notifications June 2006
Intellectual Property Statement
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.
Disclaimer of Validity
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.
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.
Acknowledgment
Funding for the RFC Editor function is currently provided by the
Internet Society.
Melnikov Expires December 19, 2006 [Page 8]