A contact item in the Exchange store. More...

#include <ews.hpp>

Inheritance diagram for ews::contact:

Public Member Functions
	contact (item_id id)

std::string	get_assistant_name () const
	Returns the contact's assistant's name.

std::string	get_birthday () const

std::string	get_business_homepage () const
	Returns the URL of the contact.

std::vector< std::string >	get_children () const

std::vector< std::string >	get_companies () const

std::string	get_company_name () const
	Returns the comany of the contact.

complete_name	get_complete_name () const
	A combination of several name fields in one convenient place.

std::string	get_contact_source () const
	Indicates whether this is a directory or a store contact. More...

std::string	get_department () const
	Return the department name of the contact.

std::string	get_display_name () const
	Returns the displayed name of the contact.

std::vector< email_address >	get_email_addresses () const
	A collection of email addresses for the contact.

std::string	get_file_as () const

internal::file_as_mapping	get_file_as_mapping () const

std::string	get_generation () const
	Returns the generation of the contact.

std::string	get_given_name () const
	Returns the person's first name.

std::vector< im_address >	get_im_addresses () const

std::string	get_initials () const
	Returns the person's initials.

std::string	get_job_title () const
	Returns the job title for the contact.

std::string	get_manager () const
	Returns the name of the contact's manager.

std::string	get_middle_name () const
	Returns the middle name of the contact.

std::string	get_mileage () const
	Returns the distance to the reference point.

std::string	get_msexchange_certificate () const

std::string	get_nickname () const
	Returns the nickname of the contact.

std::string	get_office_location () const
	Returns the location of the contact's office.

std::vector< phone_number >	get_phone_numbers () const

std::vector< physical_address >	get_physical_addresses () const
	A collection of mailing addresses for the contact.

std::string	get_profession () const
	Returns the occupation of the contact.

std::string	get_spouse_name () const
	Get name of the contact's significant other.

std::string	get_surname () const

std::string	get_user_smime_certificate () const

std::string	get_wedding_anniversary () const

void	set_assistant_name (const std::string &assistant_name)
	Sets the name of the contact's assistant.

void	set_birthday (const std::string &birthday)
	The contact's birthday.

void	set_business_homepage (const std::string &business_homepage)
	Sets the web page for the contact's business; typically a URL.

void	set_children (const std::vector< std::string > &children)
	A collection of children's names associated with the contact.

void	set_companies (const std::vector< std::string > &companies)
	A collection of companies a contact is associated with.

void	set_company_name (const std::string &company_name)
	Sets the company that the contact is affiliated with.

void	set_department (const std::string &department)
	Set the department name that the contact is in.

void	set_display_name (const std::string &display_name)
	Sets the name to display for a contact.

void	set_email_address (const email_address &address)

void	set_file_as (const std::string &fileas)
	How the name should be filed for display/sorting purposes.

void	set_file_as_mapping (internal::file_as_mapping maptype)

void	set_generation (const std::string &generation)

void	set_given_name (const std::string &given_name)

void	set_im_address (const im_address &im_address)
	A collection of instant messaging addresses for the contact.

void	set_initials (const std::string &initials)
	Set the Initials for the contact.

void	set_job_title (const std::string &title)
	Sets this contact's job title.

void	set_manager (const std::string &manager)
	Sets the name of the contact's manager.

void	set_middle_name (const std::string &middle_name)
	Set the middle name for the contact.

void	set_mileage (const std::string &mileage)

void	set_nickname (const std::string &nickname)
	Sets another name by which the contact is known.

void	set_office_location (const std::string &office_location)
	Sets the location of the contact's office.

void	set_phone_number (const phone_number &number)

void	set_physical_address (const physical_address &address)

void	set_profession (const std::string &profession)
	Sets the occupation or discipline of the contact.

void	set_spouse_name (const std::string &spouse_name)
	Set name of the contact's significant other.

void	set_surname (const std::string &surname)

void	set_wedding_anniversary (const std::string &anniversary)
	Date that the contact was married.

Public Member Functions inherited from ews::item
	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.

Static Public Member Functions
static contact	from_xml_element (const rapidxml::xml_node<> &elem)
	Makes a contact instance from a <Contact> XML element.

static contact	from_xml_element_without_item_id (const rapidxml::xml_node<> &elem)

Friends
template<typename U >
class	basic_service

Detailed Description

A contact item in the Exchange store.

Member Function Documentation

static contact ews::contact::from_xml_element_without_item_id ( const rapidxml::xml_node<> & elem )

inlinestatic

Makes a contact instance from a <Contact> XML element that has no ItemId. Is the case in resolution sets.

std::string ews::contact::get_contact_source ( ) const

inline

Indicates whether this is a directory or a store contact.

This is a read-only property.

std::string ews::contact::get_surname ( ) const

inline

Returns the family name of the contact; usually considered the last name

void ews::contact::set_file_as_mapping ( internal::file_as_mapping maptype )

inline

How the various parts of a contact's information interact to form the FileAs property value Overrides previously made FileAs settings

void ews::contact::set_generation ( const std::string & generation )

inline

Sets the generation of the contact e.g.: Sr, Jr, I, II, III, and so on

void ews::contact::set_given_name ( const std::string & given_name )

inline

Sets the name by which a person is known to given_name; often referred to as a person's first name

void ews::contact::set_mileage ( const std::string & mileage )

inline

Sets the distance that the contact resides from some reference point

void ews::contact::set_surname ( const std::string & surname )

inline

Sets the family name of the contact; usually considered the last name

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

Friends

Detailed Description

Member Function Documentation