Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 4.86 KB

README.md

File metadata and controls

86 lines (62 loc) · 4.86 KB
Raw

PHP Exchange Web Services

The PHP Exchange Web Services library (php-ews) is intended to make communication with Microsoft Exchange servers using Exchange Web Services easier. It handles the NTLM authentication required to use the SOAP services and provides an object-oriented interface to the complex types required to form a request.

Dependencies

  • PHP 5.2+
  • cURL with NTLM support (7.23.0+ recommended)
  • Exchange 2007 or 2010*

*Note: Not all operations or request elements are supported on Exchange 2007.

Installation

Clone the project from git into the desired location.

git clone git@github.com:jamesiarmes/php-ews.git php-ews

Autoloading

The library is not currently PSR-0 compliant so you will need to include files in one of two ways:

1. Include each file as you need it. Each data type is contained within its own file and will need to be included individualy. For example:

require_once 'php-ews/EWSType/CalendarItemType.php';
require_once 'php-ews/EWSType/BodyType.php';

2. Use a custom autoload function. For example:

/**
 * Function to autoload the requested class name.
 * 
 * @param string $class_name Name of the class to be loaded.
 * @return boolean Whether the class was loaded or not.
 */
function __autoload($class_name)
{
    // Start from the base path and determine the location from the class name,
    $base_path = 'path/to/php-ews;
    $include_file = $base_path . '/' . str_replace('_', '/', $class_name) . '.php';

    return (file_exists($include_file) ? require_once $include_file : false);
}

Usage

The library can be used to make several different request types. In order to make a request, you need to instantiate a new �ExchangeWebServices object:

$ews = new ExchangeWebServices($server, $username, $password, $version);

The ExchangeWebServices class takes four parameters for its constructor:

  • $server: The url to the exchange server you wish to connect to, without the protocol. Example: mail.example.com. If you have trouble determing the correct url, you could try using the EWSAutodiscover class.
  • $username: The user to connect to the server with. This is usually the local portion of the users email address. Example: "user" if the email address is "user@example.com".
  • $password: The user's plain-text password.
  • $version (optional): The version of the Exchange sever to connect to. Valid values can be found at ExchangeWebServices::VERSION_*. Defaults to Exchange 2007.

Once you have your ExchangeWebServices object, you need to build your request object. The type of object depends on the operation you are calling. If you are using an IDE with code completion it should be able to help you determine the correct classes to use using the provided docblocks.

The request objects are build similar to the XML body of the request. See the resources section below for more information on building the requests.

Resources

Support

All questions should use the issue queue. This allows the community to contribute to and benefit from questions or issues you may have. Any support requests sent to my email address will be directed here.

Contributions

Contributions are always welcome!

Contributing Code

If you would like to contribute code please fork the repository on github and issue a pull request against the master branch. It is recommended that you make any changes to your fork in a separate branch that you would then use for the pull request. If you would like to receive credit for your contribution outside of git, please add your name and email address (optional) to the CONTRIBUTORS.txt file. All contributions should follow the PSR-1 and PSR-2 coding standards.

Contributing Documentation

If you would like to contribute to the documentation, please feel free to update the wiki. I request that you do not make changes to the home page but other pages (including new ones) are fair game. Please leave a descriptive log message for any changes that you make.

Other Contributions

Have you found this library helpful? Why not take a minute to endorse my hard work on coderwall! Just click the badge below: