ExchangeWebServices.php

<?php
/**
 * Base class of the Exchange Web Services application.
 * 
 * @author James I. Armes <http://www.jamesarmes.net>
 */

/**
 * Base class of the Exchange Web Services application.
 */
class ExchangeWebServices {
	/**
	 * Microsoft Exchange 2007
	 * 
	 * @var string
	 */
	const VERSION_2007 = 'Exchange2007';
	
	/**
	 * Microsoft Exchange 2007 SP1
	 * 
	 * @var string
	 */
	const VERSION_2007_SP1 = 'Exchange2007_SP1';
	
	/**
	 * Microsoft Exchange 2010
	 * 
	 * @var string
	 */
	const VERSION_2010 = 'Exchange2010';
	
	/**
	 * Microsoft Exchange 2010 SP1
	 * 
	 * @var string
	 */
	const VERSION_2010_SP1 = 'Exchange2010_SP1';
	
	/**
	 * Microsoft Exchange 2010 SP2
	 * 
	 * @var string
	 */
	const VERSION_2010_SP2 = 'Exchange2010_SP2';
	
	/**
	 * Password to use when connecting to the Exchange server.
	 * 
	 * @var string
	 */
	protected $password;
	
	/**
	 * Location of the Exchange server.
	 * 
	 * @var string
	 */
	protected $server;
	
	/**
	 * SOAP client used to make the request
	 * 
	 * @var NTLMSoapClient_Exchange
	 */
	protected $soap;
	
	/**
	 * Username to use when connecting to the Exchange server.
	 * 
	 * @var string
	 */
	protected $username;
	
	/**
	 * Exchange impersonation
	 * 
	 * @var EWSType_ExchangeImpersonationType
	 */
	protected $impersonation;
	
	/**
	 * Miscrosoft Exchange version that we are going to connect to
	 * 
	 * @var string
	 * 
	 * @see ExchangeWebServices::VERSION_2007
	 * @see ExchangeWebServices::VERSION_2007_SP1
	 * @see ExchangeWebServices::VERSION_2010
	 * @see ExchangeWebServices::VERSION_2010_SP1
	 */
	protected $version;
	
	/**
	 * Constructor for the ExchangeWebServices class
	 * 
	 * @param string $server
	 * @param string $username
	 * @param string $password
	 * @param string $version one of the ExchangeWebServices::VERSION_* constants
	 */
	public function __construct($server = null, $username = null,
		$password = null, $version = self::VERSION_2007) {
		// set the object properties
		$this->setServer($server);
		$this->setUsername($username);
		$this->setPassword($password);
		$this->setVersion($version);
	} // end function __construct()
	
	/**
	 * Returns the SOAP Client that may be used to make calls against the server
	 * 
	 * @return NTLMSoapClient_Exchange
	 */
	public function getClient() {
		return $this->initializeSoapClient();
	} // end function getClient()
	
	/**
	 * Sets the impersonation property
	 * 
	 * @param EWSType_ExchangeImpersonationType $impersonation
	 */
	public function setImpersonation($impersonation) {
		$this->impersonation = $impersonation;
		
		return true;
	} // end function setImpersonation()
	
	/**
	 * Sets the password property
	 * 
	 * @param string $password
	 */
	public function setPassword($password) {
		$this->password = $password;
		
		return true;
	} // end function setPassword()
	
	/**
	 * Sets the server property
	 * 
	 * @param string $server
	 */
	public function setServer($server) {
		$this->server = $server;
		
		return true;
	} // end function setServer()
	
	/**
	 * Sets the user name property
	 * 
	 * @param string $username
	 */
	public function setUsername($username) {
		$this->username = $username;
		
		return true;
	} // end function setUsername()
	
	/**
	 * Sets the version property
	 * 
	 * @param string $version
	 */
	public function setVersion($version) {
		$this->version = $version;
		
		return true;
	} // end function setVersion()
	
	/**
	 * Function Description
	 * 
	 * @param AddDelegateType $request
	 * @return AddDelegateResponseMessageType
	 */
	public function AddDelegate($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function AddDelegate()
	
	/**
	 * Function Description
	 * 
	 * @param ConvertIdType $request
	 * @return ConvertIdResponseType
	 */
	public function ConvertId($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function ConvertId()
	
	/**
	 * Function Description
	 * 
	 * @param CopyFolderType $request
	 * @return CopyFolderResponseType
	 */
	public function CopyFolder($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function CopyFolder()
	
	/**
	 * Function Description
	 * 
	 * @param CopyItemType $request
	 * @return CopyItemResponseType
	 */
	public function CopyItem($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function CopyItem()
	
	/**
	 * Function Description
	 * 
	 * @param CreateAttachmentType $request
	 * @return CreateAttachmentResponseType
	 */
	public function CreateAttachment($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function CreateAttachment()
	
	/**
	 * Function Description
	 * 
	 * @param CreateFolderType $request
	 * @return CreateFolderResponseType
	 */
	public function CreateFolder($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function CreateFolder()
	
	/**
	 * Function Description
	 * 
	 * @param CreateItemType $request
	 * @return CreateItemResponseType
	 */
	public function CreateItem($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function CreateItem()
	
	/**
	 * Function Description
	 * 
	 * @param CreateManagedFolderRequestType $request
	 * @return CreateManagedFolderResponseType
	 */
	public function CreateManagedFolder($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function CreateManagedFolder()
	
	/**
	 * Function Description
	 * 
	 * @param DeleteAttachmentType $request
	 * @return DeleteAttachmentResponseType
	 */
	public function DeleteAttachment($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function DeleteAttachment()
	
	/**
	 * Function Description
	 * 
	 * @param DeleteFolderType $request
	 * @return DeleteFolderResponseType
	 */
	public function DeleteFolder($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function DeleteFolder()
	
	/**
	 * Function Description
	 * 
	 * @param DeleteItemType $request
	 * @return DeleteItemResponseType
	 */
	public function DeleteItem($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function DeleteItem()
	
	/**
	 * Function Description
	 * 
	 * @param ExpandDLType $request
	 * @return ExpandDLResponseType
	 */
	public function ExpandDL($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function ExpandDL()
	
	/**
	 * Function Description
	 * 
	 * @param EWS_FindFolderType $request
	 * @return EWS_FindFolderResponseType
	 */
	public function FindFolder($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function FindFolder()
	
	/**
	 * Function Description
	 * 
	 * @param FindItemType $request
	 * @return FindItemResponseType
	 */
	public function FindItem($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function FindItem()
	
	/**
	 * Function Description
	 * 
	 * @param GetAttachmentType $request
	 * @return GetAttachmentResponseType
	 */
	public function GetAttachment($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function GetAttachment()
	
	/**
	 * Function Description
	 * 
	 * @param GetDelegateType $request
	 * @return GetDelegateResponseMessageType
	 */
	public function GetDelegate($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function GetDelegate()
	
	/**
	 * Function Description
	 * 
	 * @param GetEventsType $request
	 * @return GetEventsResponseType
	 */
	public function GetEvents($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function GetEvents()
	
	/**
	 * Function Description
	 * 
	 * @param GetFolderType $request
	 * @return GetFolderResponseType
	 */
	public function GetFolder($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function GetFolder()
	
	/**
	 * Function Description
	 * 
	 * @param GetItemType $request
	 * @return GetItemResponseType
	 */
	public function GetItem($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function GetItem()
	
	/**
	 * Retrieve the timezones supported by the server.
	 * 
	 * @param GetServerTimeZonesType $request
	 * @return GetServerTimeZonesResponseType
	 * 
	 * @since Exchange2010
	 */
	public function GetServerTimeZones($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function GetServerTimeZones()
	
	/**
	 * Function Description
	 * 
	 * @param GetUserAvailabilityRequestType $request
	 * @return GetUserAvailabilityResponseType
	 */
	public function GetUserAvailability($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function GetUserAvailability()
	
	/**
	 * Function Description
	 * 
	 * @param GetUserOofSettingsRequest $request
	 * @return GetUserOofSettingsResponse
	 */
	public function GetUserOofSettings($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function GetUserOofSettings()
	
	/**
	 * Function Description
	 * 
	 * @param MoveFolderType $request
	 * @return MoveFolderResponseType
	 */
	public function MoveFolder($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function MoveFolder()
	
	/**
	 * Function Description
	 * 
	 * @param MoveItemType $request
	 * @return MoveItemResponseType
	 */
	public function MoveItem($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function MoveItem()
	
	/**
	 * Function Description
	 * 
	 * @param RemoveDelegateType $request
	 * @return RemoveDelegateResponseMessageType
	 */
	public function RemoveDelegate($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function RemoveDelegate()
	
	/**
	 * Function Description
	 * 
	 * @param ResolveNamesType $request
	 * @return ResolveNamesResponseType
	 */
	public function ResolveNames($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function ResolveNames()
	
	/**
	 * Function Description
	 * 
	 * @param SendItemType $request
	 * @return SendItemResponseType
	 */
	public function SendItem($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function SendItem()
	
	/**
	 * Function Description
	 * 
	 * @param SetUserOofSettingsRequest $request
	 * @return SetUserOofSettingsResponse
	 */
	public function SetUserOofSettings($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function SetUserOofSettings()
	
	/**
	 * Function Description
	 * 
	 * @param SubscribeType $request
	 * @return SubscribeResponseType
	 */
	public function Subscribe($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function Subscribe()
	
	/**
	 * Function Description
	 * 
	 * @param SyncFolderHierarchyType $request
	 * @return SyncFolderHierarchyResponseType
	 */
	public function SyncFolderHierarchy($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function SyncFolderHierarchy()
	
	/**
	 * Function Description
	 * 
	 * @param SyncFolderItemsType $request
	 * @return SyncFolderItemsResponseType
	 */
	public function SyncFolderItems($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function SyncFolderItems()
	
	/**
	 * Function Description
	 * 
	 * @param UnsubscribeType $request
	 * @return UnsubscribeResponseType
	 */
	public function Unsubscribe($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function Unsubscribe()
	
	/**
	 * Function Description
	 * 
	 * @param UpdateDelegateType $request
	 * @return UpdateDelegateResponseMessageType
	 */
	public function UpdateDelegate($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function UpdateDelegate()
	
	/**
	 * Function Description
	 * 
	 * @param UpdateFolderType $request
	 * @return UpdateFolderResponseType
	 */
	public function UpdateFolder($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function UpdateFolder()
	
	/**
	 * Function Description
	 * 
	 * @param UpdateItemType $request
	 * @return UpdateItemResponseType
	 */
	public function UpdateItem($request) {
		$this->initializeSoapClient();
		$response = $this->soap->{__FUNCTION__}($request);
		
		return $this->processResponse($response);
	} // end function UpdateItem()
	
	/**
	 * Initializes the SoapClient object to make a request
	 * 
	 * @return NTLMSoapClient_Exchange
	 */
	protected function initializeSoapClient() {
		$this->soap = new NTLMSoapClient_Exchange(
			dirname(__FILE__).'/wsdl/services.wsdl',
			array(
				'user' => $this->username,
				'password' => $this->password,
				'version' => $this->version,
				'location' => 'https://'.$this->server.'/EWS/Exchange.asmx',
				'impersonation' => $this->impersonation,
			)); // end return
		
		return $this->soap;
	} // end function initializeSoapClient()
	
	/**
	 * Process a response to verify that it succeeded and take the appropriate
	 * action
	 * 
	 * @throws EWS_Exception
	 * 
	 * @param stdClass $response
	 * @return EWSType
	 * 
	 * @todo map the response to a real object
	 */
	protected function processResponse($response) {
		// if the soap call failed then we need to thow an exception
		$code = $this->soap->getResponseCode();
		if ($code != 200) {
			throw new EWS_Exception('SOAP client returned status of '.$code, $code);
		} // end if the soap called
		
		// TODO: map the response to a real object
		return $response;
	} // end function processResponse()
} // end class ExchangeWebService