Represents a generic <Item> in the Exchange store. More...

#include <ews.hpp>

Inheritance diagram for ews::item:

Public Member Functions
	item ()
	Constructs a new item.

	item (item_id id)
	Constructs a new item with the given id.

std::vector< std::string >	get_array_of_strings_helper (const char *name) const

std::vector< attachment >	get_attachments () const
	Returns the items or files that are attached to this item.

body	get_body () const
	Returns the body of this item.

std::vector< std::string >	get_categories () const
	Returns the categories associated with this item. More...

std::string	get_culture () const
	Returns the culture name associated with the body of this item.

date_time	get_date_time_created () const
	Returns the date/time this item was created. More...

date_time	get_date_time_received () const
	Date/Time an item was received. More...

date_time	get_date_time_sent () const
	Returns the date/time this item was sent. More...

std::string	get_display_cc () const
	Returns a nice string containing all Cc: recipients of this item. More...

std::string	get_display_to () const
	Returns a nice string containing all To: recipients of this item. More...

std::vector< extended_property >	get_extended_properties () const

importance	get_importance () const
	Returns the importance of this item.

std::string	get_in_reply_to () const
	Returns the identifier of the item to which this item is a reply. More...

std::vector< internet_message_header >	get_internet_message_headers () const
	Returns a collection of Internet message headers associated with this item. More...

std::string	get_item_class () const
	Returns the PR_MESSAGE_CLASS MAPI property (the message class) for an item.

const item_id &	get_item_id () const EWS_NOEXCEPT
	Returns the id of an item.

mime_content	get_mime_content () const
	Base64-encoded contents of the MIME stream of this item.

folder_id	get_parent_folder_id () const
	Returns a unique identifier for the folder that contains this item. More...

date_time	get_reminder_due_by () const
	Returns the due date of this item. More...

uint32_t	get_reminder_minutes_before_start () const
	Returns the number of minutes before due date that a reminder should be shown to the user.

sensitivity	get_sensitivity () const
	Returns the sensitivity level of this item.

size_t	get_size () const
	Size in bytes of an item. More...

std::string	get_subject () const
	Returns this item's subject.

bool	has_attachments () const
	True if this item has non-hidden attachments. More...

bool	is_draft () const
	True if this item is a draft. More...

bool	is_from_me () const
	True if this item is from you. More...

bool	is_reminder_enabled () const
	True if a reminder has been enabled on this item.

bool	is_resend () const
	True if this item a re-send. More...

bool	is_submitted () const
	True if this item has been submitted for delivery. More...

bool	is_unmodified () const
	True if this item is unmodified. More...

void	set_array_of_strings_helper (const std::vector< std::string > &strings, const char *name)

void	set_body (const body &b)
	Sets the body of this item.

void	set_categories (const std::vector< std::string > &categories)
	Sets this item's categories. More...

void	set_culture (const std::string &culture)
	Sets the culture name associated with the body of this item.

void	set_extended_property (const extended_property &extended_prop)
	Sets an extended property of an item.

void	set_importance (importance i)
	Sets the importance of the item.

void	set_reminder_due_by (const date_time &due_by)
	Sets the due date of this item. More...

void	set_reminder_enabled (bool enabled)
	Set a reminder on this item.

void	set_reminder_minutes_before_start (uint32_t minutes)
	Sets the minutes before due date that a reminder should be shown to the user.

void	set_sensitivity (sensitivity s)
	Sets the sensitivity level of this item.

void	set_subject (const std::string &subject)
	Sets this item's subject. Limited to 255 characters.

Friends
class	attachment

Detailed Description

Represents a generic <Item> in the Exchange store.

Items are, along folders, the fundamental entity that is stored in an Exchange store. An item can represent a mail message, an appointment, or a colleague's contact data. Most of the times, you deal with those specialized item types when working with the EWS API. In some cases though, it is easier to use the more general item class directly.

The item base-class contains all properties that are common among all concrete sub-classes, most notably the <Subject>, <Body>, and <ItemId> properties.

Like folders, each item that exists in an Exchange store has a unique identifier attached to it. This is represented by the item_id class and you'd use and item's get_item_id member-function to obtain a reference to it.

Member Function Documentation

std::vector<std::string> ews::item::get_categories ( ) const

inline

Returns the categories associated with this item.

See also: item::set_categories

date_time ews::item::get_date_time_created ( ) const

inline

Returns the date/time this item was created.

This is a read-only property.

date_time ews::item::get_date_time_received ( ) const

inline

Date/Time an item was received.

This is a read-only property.

date_time ews::item::get_date_time_sent ( ) const

inline

Returns the date/time this item was sent.

This is a read-only property.

std::string ews::item::get_display_cc ( ) const

inline

Returns a nice string containing all Cc: recipients of this item.

The <DisplayCc/> property is a concatenated string of the display names of the Cc: recipients of an item. Each recipient is separated by a semicolon. This is a read-only property.

std::string ews::item::get_display_to ( ) const

inline

Returns a nice string containing all To: recipients of this item.

The <DisplayTo/> property is a concatenated string of the display names of all the To: recipients of an item. Each recipient is separated by a semicolon. This is a read-only property.

std::vector<extended_property> ews::item::get_extended_properties ( ) const

inline

List of zero or more extended properties that are requested for an item

std::string ews::item::get_in_reply_to ( ) const

inline

Returns the identifier of the item to which this item is a reply.

This is a read-only property.

std::vector<internet_message_header> ews::item::get_internet_message_headers ( ) const

inline

Returns a collection of Internet message headers associated with this item.

This is a read-only property.

See also: internet_message_header

folder_id ews::item::get_parent_folder_id ( ) const

inline

Returns a unique identifier for the folder that contains this item.

This is a read-only property.

date_time ews::item::get_reminder_due_by ( ) const

inline

Returns the due date of this item.

See also: item::set_reminder_due_by

size_t ews::item::get_size ( ) const

inline

Size in bytes of an item.

This is a read-only property. Default: 0

bool ews::item::has_attachments ( ) const

inline

True if this item has non-hidden attachments.

This is a read-only property.

bool ews::item::is_draft ( ) const

inline

True if this item is a draft.

Default: false

bool ews::item::is_from_me ( ) const

inline

True if this item is from you.

Default: false.

bool ews::item::is_resend ( ) const

inline

True if this item a re-send.

Default: false

bool ews::item::is_submitted ( ) const

inline

True if this item has been submitted for delivery.

Default: false.

bool ews::item::is_unmodified ( ) const

inline

True if this item is unmodified.

Default: false.

void ews::item::set_categories ( const std::vector< std::string > & categories )

inline

Sets this item's categories.

A category is a short user-defined string that groups items with the same category together. An item can have none or multiple categories assigned. Think of tags or Google Mail labels.

See also: item::get_categories

void ews::item::set_reminder_due_by ( const date_time & due_by )

inline

Sets the due date of this item.

Used for reminders.

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

/home/travis/build/otris/ews-cpp/include/ews/ews.hpp

Public Member Functions

Friends

Detailed Description

Member Function Documentation