ews-cpp  0.9
Public Types | Public Member Functions | List of all members
ews::update Class Referencefinal

An update to a single property of an item. More...

#include <ews.hpp>

Public Types

enum  operation {
  operation::set_item_field,
  operation::append_to_item_field,
  operation::delete_item_field
}
 

Public Member Functions

 update (property prop, operation action=operation::set_item_field)
 
 update (extended_property prop, operation action=operation::set_item_field)
 
std::string to_folder_xml () const
 Serializes this update instance to an XML string for folder operations.
 
std::string to_item_xml () const
 Serializes this update instance to an XML string for item operations.
 

Detailed Description

An update to a single property of an item.

Represents either a <SetItemField>, an <AppendToItemField>, or a <DeleteItemField> operation.

Member Enumeration Documentation

Enumerator
set_item_field 

Replaces or creates a property.

Replaces data for a property if the property already exists, otherwise creates the property and sets its value. The operation is only applicable to read-write properties.

append_to_item_field 

Adds data to an existing property.

This works only on some properties, such as

  • calendar:OptionalAttendees
  • calendar:RequiredAttendees
  • calendar:Resources
  • item:Body
  • message:ToRecipients
  • message:CcRecipients
  • message:BccRecipients
  • message:ReplyTo
delete_item_field 

Removes a property from an item.

Only applicable to read-write properties.


The documentation for this class was generated from the following file: