[MS-OXOFLAG]:
Informational Flagging Protocol
Intellectual Property Rights Notice for Open Specifications Documentation
§ Technical Documentation. Microsoft publishes Open Specifications documentation for protocols, file formats, languages, standards as well as overviews of the interaction among each of these technologies.
§ Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you may make copies of it in order to develop implementations of the technologies described in the Open Specifications and may distribute portions of it in your implementations using these technologies or your documentation as necessary to properly document the implementation. You may also distribute in your implementation, with or without modification, any schema, IDL’s, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications.
§ No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.
§ Patents. Microsoft has patents that may cover your implementations of the technologies described in the Open Specifications. Neither this notice nor Microsoft's delivery of the documentation grants any licenses under those or any other Microsoft patents. However, a given Open Specification may be covered by Microsoft Open Specification Promise or the Community Promise. If you would prefer a written license, or if the technologies described in the Open Specifications are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting .
§ Trademarks. The names of companies and products contained in this documentation may be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit www.microsoft.com/trademarks.
§ Fictitious Names. The example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than specifically described above, whether by implication, estoppel, or otherwise.
Tools. The Open Specifications do not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments you are free to take advantage of them. Certain Open Specifications are intended for use in conjunction with publicly available standard specifications and network programming art, and assumes that the reader either is familiar with the aforementioned material or has immediate access to it.
Revision Summary
Date / Revision History / Revision Class / Comments /04/04/2008 / 0.1 / Initial Availability.
04/25/2008 / 0.2 / Revised and updated property names and other technical content.
06/27/2008 / 1.0 / Initial Release.
08/06/2008 / 1.01 / Revised and edited technical content.
09/03/2008 / 1.02 / Revised and edited technical content.
12/03/2008 / 1.03 / Revised and edited technical content.
04/10/2009 / 2.0 / Updated technical content and applicable product releases.
07/15/2009 / 3.0 / Major / Revised and edited for technical content.
11/04/2009 / 4.0.0 / Major / Updated and revised the technical content.
02/10/2010 / 5.0.0 / Major / Updated and revised the technical content.
05/05/2010 / 5.0.1 / Editorial / Revised and edited the technical content.
08/04/2010 / 5.1 / Minor / Clarified the meaning of the technical content.
11/03/2010 / 5.2 / Minor / Clarified the meaning of the technical content.
03/18/2011 / 5.2 / No change / No changes to the meaning, language, and formatting of the technical content.
08/05/2011 / 5.2 / No change / No changes to the meaning, language, or formatting of the technical content.
10/07/2011 / 5.2 / No change / No changes to the meaning, language, or formatting of the technical content.
01/20/2012 / 6.0 / Major / Significantly changed the technical content.
04/27/2012 / 6.1 / Minor / Clarified the meaning of the technical content.
07/16/2012 / 7.0 / Major / Significantly changed the technical content.
10/08/2012 / 7.1 / Minor / Clarified the meaning of the technical content.
02/11/2013 / 7.1 / No change / No changes to the meaning, language, or formatting of the technical content.
1/1
[MS-OXOFLAG] — v20130203
Informational Flagging Protocol
Copyright © 2013 Microsoft Corporation.
Release: February 11, 2013
Table of Contents
1 Introduction 5
1.1 Glossary 5
1.2 References 6
1.2.1 Normative References 6
1.2.2 Informative References 7
1.3 Overview 7
1.4 Relationship to Other Protocols 7
1.5 Prerequisites/Preconditions 7
1.6 Applicability Statement 7
1.7 Versioning and Capability Negotiation 7
1.8 Vendor-Extensible Fields 7
1.9 Standards Assignments 8
2 Messages 9
2.1 Transport 9
2.2 Message Syntax 9
2.2.1 Properties Specific to the Informational Flagging Protocol 9
2.2.1.1 PidTagFlagStatus Property 9
2.2.1.2 PidTagFollowupIcon Property 9
2.2.1.3 PidTagFlagCompleteTime Property 10
2.2.1.4 PidTagReplyRequested Property 10
2.2.1.5 PidTagResponseRequested Property 10
2.2.1.6 PidTagToDoItemFlags Property 10
2.2.1.7 PidTagSwappedToDoData Property 11
2.2.1.8 PidTagSwappedToDoStore Property 13
2.2.1.9 PidLidFlagRequest Property 13
2.2.1.10 PidLidFlagString Property 13
2.2.1.11 PidLidValidFlagStringProof Property 14
2.2.1.12 PidLidToDoTitle Property 14
2.2.1.13 PidLidToDoOrdinalDate Property 15
2.2.1.14 PidLidToDoSubOrdinal Property 15
2.2.2 Properties Shared with the Task-Related Object Protocol 15
2.2.2.1 PidLidTaskStatus Property 16
2.2.2.2 PidLidTaskComplete Property 16
2.2.2.3 PidLidPercentComplete Property 16
2.2.3 Properties Shared with the Reminder Settings Protocol 17
2.2.3.1 PidTagReplyTime Property 17
3 Protocol Details 18
3.1 Client Details 18
3.1.1 Abstract Data Model 18
3.1.2 Timers 18
3.1.3 Initialization 18
3.1.4 Higher-Layer Triggered Events 18
3.1.4.1 Flagging a Message Object 18
3.1.4.1.1 Setting a Color Flag 19
3.1.4.1.2 Setting a Basic Flag 19
3.1.4.1.3 Setting a Time Flag 19
3.1.4.1.4 Setting a Complete Flag 20
3.1.4.1.5 Setting a Recipient Flag 21
3.1.4.1.6 Setting a Sender Flag 21
3.1.4.2 Clearing a Flag on a Message Object 21
3.1.4.2.1 Clearing a Flag on a Meeting-Related Object 21
3.1.4.2.2 Clearing a Flag on a Task Object 22
3.1.4.2.3 Clearing a Flag on Other Message Objects 22
3.1.4.3 Post-Transmit Processing of a Flagged Message 22
3.1.5 Message Processing Events and Sequencing Rules 23
3.1.6 Timer Events 23
3.1.7 Other Local Events 23
3.2 Server Details 23
3.2.1 Abstract Data Model 23
3.2.2 Timers 24
3.2.3 Initialization 24
3.2.4 Higher-Layer Triggered Events 24
3.2.5 Message Processing Events and Sequencing Rules 24
3.2.6 Timer Events 24
3.2.7 Other Local Events 24
4 Protocol Examples 25
4.1 Color-Flagged Object 26
4.2 Time Flagged Object 27
4.3 Completed Object 29
4.4 Flagging a Draft Message Object for the Sender and Recipient 30
5 Security 36
5.1 Security Considerations for Implementers 36
5.2 Index of Security Parameters 36
6 Appendix A: Product Behavior 37
7 Change Tracking 39
8 Index 40
1/1
[MS-OXOFLAG] — v20130203
Informational Flagging Protocol
Copyright © 2013 Microsoft Corporation.
Release: February 11, 2013
1 Introduction
The Informational Flagging Protocol allows a Message object to be marked for either follow-up or categorization. This protocol extends the Message and Attachment Object Protocol, which is described in [MS-OXCMSG].
Sections 1.8, 2, and 3 of this specification are normative and can contain the terms MAY, SHOULD, MUST, MUST NOT, and SHOULD NOT as defined in RFC 2119. Sections 1.5 and 1.9 are also normative but cannot contain those terms. All other sections and examples in this specification are informative.
1.1 Glossary
The following terms are defined in [MS-GLOS]:
Coordinated Universal Time (UTC)
handle
Unicode
The following terms are defined in [MS-OXGLOS]:
Appointment object
basic flag
color flag
Contact object
Draft Message object
Email object
Journal object
mailbox
meeting-related object
Message object
named property
Note object
property ID
recipient
reminder
reminder properties
remote operation (ROP)
ROP request
ROP request buffer
ROP response
ROP response buffer
Task object
time flag
The following terms are specific to this document:
complete flag: A flag on a messaging object that indicates that the associated work item has been completed.
consolidated to-do list: A list of all tasks and flagged Message objects that are in a user's mailbox.
primary flag storage location: The typical location that is used to store flagging properties, as opposed to the secondary flag storage location.
recipient flag: A collection of property values indicating that a draft Message object is marked such that it will appear as flagged with a basic flag to recipients.
recipient reminder: A collection of property values indicating that a Draft Message object is marked such that it will have an active reminder for the recipients of the Message Object.
secondary flag storage location: A binary property that is used to encode a second set of flagging properties, which do not affect the flagged state of a Message object.
sender flag: A collection of property values that indicate that a Draft Message object has been marked such that the copy of the Message object that is saved in the sender's mailbox after the message is sent will appear flagged to the sender.
sender reminder: A collection of property values that indicate that a Draft Message object has been marked such that the copy of the Message object that is saved in the sender’s mailbox after the message is sent will have an active reminder.
MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as described in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.
1.2 References
References to Microsoft Open Specifications documentation do not include a publishing year because links are to the latest version of the technical documents, which are updated frequently. References to other documents include a publishing year when one is available.
1.2.1 Normative References
We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. Please check the archive site, http://msdn2.microsoft.com/en-us/library/E4BD6494-06AD-4aed-9823-445E921C9624, as an additional source.
[MS-OXCDATA] Microsoft Corporation, "Data Structures".
[MS-OXCMSG] Microsoft Corporation, "Message and Attachment Object Protocol".
[MS-OXCPRPT] Microsoft Corporation, "Property and Stream Object Protocol".
[MS-OXCROPS] Microsoft Corporation, "Remote Operations (ROP) List and Encoding Protocol".
[MS-OXCSTOR] Microsoft Corporation, "Store Object Protocol".
[MS-OXOCAL] Microsoft Corporation, "Appointment and Meeting Object Protocol".
[MS-OXOMSG] Microsoft Corporation, "Email Object Protocol".
[MS-OXORMDR] Microsoft Corporation, "Reminder Settings Protocol".
[MS-OXOTASK] Microsoft Corporation, "Task-Related Objects Protocol".
[MS-OXPROPS] Microsoft Corporation, "Exchange Server Protocols Master Property List".
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, http://www.rfc-editor.org/rfc/rfc2119.txt
1.2.2 Informative References
[MS-GLOS] Microsoft Corporation, "Windows Protocols Master Glossary".
[MS-OXGLOS] Microsoft Corporation, "Exchange Server Protocols Master Glossary".
[MS-OXPROTO] Microsoft Corporation, "Exchange Server Protocols System Overview".
1.3 Overview
The Informational Flagging Protocol allows a user to mark an item for either follow-up or categoriztion. The marker is referred to as a flag. By flagging an item for follow up, the user can track the progress and completion of an associated work item. Categorizing items with flags enables a user to organize items in the user's mailbox. For example, users can assign start dates and due dates to their flagged items to prioritize their work, or they can assign a flag color to group related items.
This protocol specifies a set of properties that identify a Message object as being flagged. There are six different types of flags: basic flag, color flag, time flag, complete flag, recipient flag, and sender flag. A Message object that is delivered to a recipient (1) and the sender's copy of that Message object can have their flag-related properties set independently of each other.
This protocol extends the Message and Attachment Object Protocol, described in [MS-OXCMSG], in that it adds capability for flagging a Message object.
1.4 Relationship to Other Protocols
The Informational Flagging Protocol has the same dependencies as the Message and Attachment Object Protocol, which is described in [MS-OXCMSG]. A sender flag is closely related to a sender reminder, which is described in [MS-OXORMDR].
For conceptual background information and overviews of the relationships and interactions between this and other protocols, see [MS-OXPROTO].
1.5 Prerequisites/Preconditions
This protocol assumes that the client has previously logged on to the server, as specified in [MS-OXCSTOR], and has acquired a handle to the Message object on which it intends to operate.
1.6 Applicability Statement
A client can use the Informational Flagging Protocol to set various flags on a Message object. This protocol is intended to be a complement, and not a substitute, for full task management, which is described in [MS-OXOTASK].
1.7 Versioning and Capability Negotiation
None.
1.8 Vendor-Extensible Fields
None.
1.9 Standards Assignments
None.
2 Messages
2.1 Transport
The Informational Flagging Protocol uses the same underlying transport as that used by the Message and Attachment Object Protocol, which is specified in [MS-OXCMSG].
2.2 Message Syntax
A Message object can have its flag state changed by the client. Constraints for setting flags on a Message object are defined in section 2.2.1 through section 2.2.3.
When a value is specified as not present, the property MUST NOT exist on the Message object, and if it exists, it MUST be deleted. Setting a property value to 0 or to a zero-length string does not delete the value of the property from the Message object.
2.2.1 Properties Specific to the Informational Flagging Protocol
2.2.1.1 PidTagFlagStatus Property
Type: PtypInteger32 ([MS-OXCDATA] section 2.11.1)
The PidTagFlagStatus property ([MS-OXPROPS] section 2.767) specifies the flag state of the Message object. This property is present on the Message object only if the object has been flagged and is not present otherwise. It MUST NOT exist on a meeting-related object, and it SHOULD NOT<1> exist on a Task object. When acting on other Message objects, this property is set to one of the following values.
Numeric value / Name / Meaning /0x00000001 / followupComplete / The object is flagged as complete. This value is valid only for a complete flag.
0x00000002 / followupFlagged / The object is flagged for follow-up. This value is valid for a basic flag, a color flag, a time flag, and a recipient flag.
2.2.1.2 PidTagFollowupIcon Property