Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 3.99 KB

README.md

File metadata and controls

107 lines (80 loc) · 3.99 KB
Raw

1PHP 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.

Scrutinizer Total Downloads

Dependencies

  • Composer
  • PHP 5.4 or greater
  • cURL with NTLM support (7.30.0+ recommended)
  • Exchange 2007 or later

Note: Not all operations or request elements are supported on all versions of Exchange.

Installation

The prefered installation method is via Composer, which will automatically handle autoloading of classes.

{
    "require": {
        "php-ews/php-ews": "~1.0"
    }
}

Usage

The library can be used to make several different request types. In order to make a request, you need to instantiate a new \jamesiarmes\PhpEws\Client object:

use \jamesiarmes\PhpEws\Client;

$ews = new Client($server, $version);
$ews->authWithOauth2($accesskey);
$ews->authWithUserAndPass($username, $password);

The Client class takes two 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 determining the correct url, you could try using autodiscovery.
  • $version (optional): The version of the Exchange sever to connect to. Valid values can be found at \jamesiarmes\PhpEws\Client::VERSION_*. Defaults to Exchange 2007.

The authWithOauth2 method takes one parameters (used for office365):

  • $accesskey: An accesstoken you get from https://login.microsoftonline.com/APP-ID/oauth2/v2.0/token This accesstoken is 60 minuted valid, after this time use refresh token to get a new one. The refreshtoken is valid for a long time, when it expires, get a new one by reauth you office 365 account.

The authWithUserAndPass method takes two parameters (used for on premises):

  • $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 "[email protected]".
  • $password: The user's plain-text password.

Once you have your \jamesiarmes\PhpEws\Client 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.

Examples

There are a number of examples included in the examples directory. These examples are meant to be run from the command line. In each, you will need to set the connection information variables to match those of your Exchange server. For some of them, you will also need to set ids or additional data that will be used in the request.

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 received via email will be directed here.