Renders a <DistinguishedFolderId> element. More...

#include <ews.hpp>

Inheritance diagram for ews::distinguished_folder_id:

Public Member Functions
	distinguished_folder_id (standard_folder folder)
	Creates a `<DistinguishedFolderId>` element for a given well-known folder.

	distinguished_folder_id (standard_folder folder, std::string change_key)
	Creates a `<DistinguishedFolderId>` element for a given well-known folder and change key.

	distinguished_folder_id (standard_folder folder, mailbox owner)
	Constructor for EWS delegate access. More...

Public Member Functions inherited from ews::folder_id
	folder_id (std::string id)

	folder_id (std::string id, std::string change_key)

const std::string &	change_key () const EWS_NOEXCEPT
	Returns a string identifying a version of a folder.

const std::string &	id () const EWS_NOEXCEPT
	Returns a string identifying a folder in the Exchange store.

std::string	to_xml () const

bool	valid () const EWS_NOEXCEPT
	Whether this folder_id is valid.

Static Public Member Functions
static standard_folder	str_to_standard_folder (const std::string &name)
	Returns the standard_folder enum for given string.

static std::string	well_known_name (standard_folder enumeration)
	Returns the well-known name for given standard_folder as string.

Static Public Member Functions inherited from ews::folder_id
static folder_id	from_xml_element (const rapidxml::xml_node<> &elem)
	Makes a folder_id instance from given XML element.

Detailed Description

Renders a <DistinguishedFolderId> element.

Implicitly convertible from standard_folder.

Constructor & Destructor Documentation

ews::distinguished_folder_id::distinguished_folder_id	(	standard_folder	folder,
		mailbox	owner
	)

inline

Constructor for EWS delegate access.

Creates a <DistinguishedFolderId> element for a well-known folder of a different user. The user is the folder's owner.

By specifying a well-known folder name and a SMTP mailbox address, a delegate can get access to the mailbox owner's folder and the items therein. If the resulting distinguished_folder_id is used in a subsequent find_item, get_{task,message,calendar_item,contact} call, the returned item_ids allow implicit access to the mailbox owner's items.

This access pattern is described as explicit/implicit access in Microsoft's documentation.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation