Documentation

Client
in package

php

ews

Client

Base class of the Exchange Web Services application.

Constants

VERSION_2007 = 'Exchange2007': Microsoft Exchange 2007
VERSION_2007_SP1 = 'Exchange2007_SP1': Microsoft Exchange 2007 SP1
VERSION_2009 = 'Exchange2009': Microsoft Exchange 2007 SP2
VERSION_2010 = 'Exchange2010': Microsoft Exchange 2010
VERSION_2010_SP1 = 'Exchange2010_SP1': Microsoft Exchange 2010 SP1
VERSION_2010_SP2 = 'Exchange2010_SP2': Microsoft Exchange 2010 SP2
VERSION_2013 = 'Exchange2013': Microsoft Exchange 2013.
VERSION_2013_SP1 = 'Exchange2013_SP1': Microsoft Exchange 2013 SP1.
VERSION_2016 = 'Exchange2016': Microsoft Exchange 2016.

Properties

$curl_options : array<string|int, mixed>: cURL options to be passed to the SOAP client.
$headers : array<string|int, SoapHeader>: SOAP headers used for requests.
$impersonation : ExchangeImpersonationType: Exchange impersonation
$password : string: Password to use when connecting to the Exchange server.
$server : string: Location of the Exchange server.
$soap : null|SoapClient: SOAP client used to make the request.
$timezone : string: Timezone to be used for all requests.
$username : string: Username to use when connecting to the Exchange server.
$version : string: Microsoft Exchange version that we are going to connect to

Methods

__construct() : mixed: Constructor for the ExchangeWebServices class
AddDelegate() : AddDelegateResponseMessageType: Adds one or more delegates to a principal's mailbox and sets specific access permissions.
AddDistributionGroupToImList() : AddDistributionGroupToImListResponseMessageType: Adds a distribution group to the instant messaging (IM) list in the Unified Contact Store.
AddImContactToGroup() : AddImContactToGroupResponseMessageType: Adds an existing instant messaging (IM) contact to a group.
AddImGroup() : AddImGroupResponseMessageType: Adds a new instant messaging (IM) group to a mailbox.
AddNewImContactToGroup() : AddNewImContactToGroupResponseMessageType: Adds a new contact to an instant messaging (IM) group.
AddNewTelUriContactToGroup() : AddNewTelUriContactToGroupResponse: Adds a new contact to a group based on a contact's phone number.
ApplyConversationAction() : ApplyConversationActionResponseType: Sets a one-time or follow up action on all the items in a conversation.
ArchiveItem() : ArchiveItemResponse: Moves an item into the mailbox user's archive mailbox.
ConvertId() : ConvertIdResponseType: Converts item and folder identifiers between formats that are accepted by Exchange Online, Exchange Online as part of Office 365, and on-premises versions of Exchange.
CopyFolder() : CopyFolderResponseType: Copies folders in a mailbox.
CopyItem() : CopyItemResponseType: Copies items and puts the items in a different folder.
CreateAttachment() : CreateAttachmentResponseType: Creates either an item or file attachment and attaches it to the specified item.
CreateFolder() : CreateFolderResponseType: Creates folders, calendar folders, contacts folders, tasks folders, and search folders.
CreateFolderPath() : CreateFolderPathResponseType: Creates a folder hierarchy.
CreateItem() : CreateItemResponseType: Creates items in the Exchange store.
CreateManagedFolder() : CreateManagedFolderResponseType: Creates a managed folder in the Exchange store.
CreateUserConfiguration() : CreateUserConfigurationResponseType: Creates a user configuration object on a folder.
DeleteAttachment() : DeleteAttachmentResponseType: Deletes file and item attachments from an existing item in the Exchange store.
DeleteFolder() : DeleteFolderResponseType: Deletes folders from a mailbox.
DeleteItem() : DeleteItemResponseType: Deletes items in the Exchange store.
DeleteUserConfiguration() : DeleteUserConfigurationResponseType: Deletes a user configuration object on a folder.
DisableApp() : DisableAppResponseType: Disables a mail app for Outlook.
DisconnectPhoneCall() : DisconnectPhoneCallResponseMessageType: Terminates a telephone call.
EmptyFolder() : EmptyFolderResponseType: Empties folders in a mailbox.
ExpandDL() : ExpandDLResponseType: Exposes the full membership of distribution lists.
ExportItems() : ExportItemsResponseType: Exports items out of a mailbox.
FindConversation() : FindConversationResponseMessageType: Enumerates a list of conversations in a folder.
FindFolder() : FindFolderResponseType: Finds subfolders of an identified folder and returns a set of properties that describe the set of subfolders.
FindItem() : FindItemResponseType: Searches for items that are located in a user’s mailbox.
FindMessageTrackingReport() : FindMessageTrackingReportResponseMessageType: Finds messages that meet the specified criteria.
FindPeople() : FindPeopleResponseMessageType: Returns all persona objects from a specified Contacts folder or retrieves contacts that match a specified query string.
GetAppManifests() : GetAppManifestsResponseType: Retrieves app manifests.
GetAppMarketplaceUrl() : GetAppMarketplaceUrlResponseMessageType: Retrieves the URL for the app marketplace that a client can visit to acquire apps to install in a mailbox.
GetAttachment() : GetAttachmentResponseType: Retrieves existing attachments on items in the Exchange store.
getClient() : SoapClient: Returns the SOAP Client that may be used to make calls against the server
GetClientAccessToken() : GetClientAccessTokenResponseType: Gets a client access token for a mail app for Outlook.
GetConversationItems() : GetConversationItemsResponseType: Retrieves one or more sets of items that are organized in to nodes in a conversation.
GetDelegate() : GetDelegateResponseMessageType: Retrieves the delegate settings for a specified mailbox.
GetDiscoverySearchConfiguration() : GetDiscoverySearchConfigurationResponseMessageType: Returns configuration information for in-place holds, saved discovery searches, and the mailboxes that are enabled for discovery search.
GetEvents() : GetEventsResponseType: Used by pull subscription clients to request notifications from the Client Access server.
GetFolder() : GetFolderResponseType: Gets folders from the Exchange store.
GetHoldOnMailboxes() : GetHoldOnMailboxesResponseMessageType: Retrieves the mailboxes that are under a specific hold and the associated hold query.
GetImItemList() : GetImItemListResponseMessageType: Retrieves the list of instant messaging (IM) groups and IM contact personas in a mailbox.
GetImItems() : GetImItemsResponse: Retrieves information about instant messaging (IM) groups and IM contact personas.
GetInboxRules() : GetInboxRulesResponseType: Retrieves Inbox rules in the identified user's mailbox.
GetItem() : GetItemResponseType: Gets folders from the Exchange store.
GetMailTips() : GetMailTipsResponseMessageType: Retrieves the mail tips information for the specified mailbox.
GetMessageTrackingReport() : GetMessageTrackingReportResponseMessageType: Retrieves tracking information about the specified messages.
GetNonIndexableItemDetails() : GetNonIndexableItemDetailsResponseMessageType: Retrieves details about items that cannot be indexed.
GetNonIndexableItemStatistics() : GetNonIndexableItemStatisticsResponseMessageType: Retrieves the count of items that cannot be indexed in a mailbox.
GetPasswordExpirationDate() : GetPasswordExpirationDateResponseMessageType: Provides the email account password expiration date for the current user.
GetPersona() : GetPersonaResponseMessageType: Retrieves a set of properties that are associated with a persona.
GetPhoneCallInformation() : GetPhoneCallInformationResponseMessageType: Retrieves information about the specified telephone call.
GetReminders() : GetRemindersResponseMessageType: Retrieves reminders for calendar and task items.
GetRoomLists() : GetRoomListsResponseMessageType: Retrieves the room lists that are available within the Exchange organization.
GetRooms() : GetRoomsResponseMessageType: Retrieves the rooms within the specified room list.
GetSearchableMailboxes() : GetSearchableMailboxesResponseMessageType: Retrieves a scoped set of searchable mailboxes for discovery searches.
GetServerTimeZones() : GetServerTimeZonesResponseType: Retrieve the timezones supported by the server.
GetServiceConfiguration() : GetServiceConfigurationResponseMessageType: Retrieves configuration information for the specified type of service.
GetSharingFolder() : GetSharingFolderResponseMessageType: Retrieves the local folder identifier of a specified shared folder.
GetSharingMetadata() : GetSharingMetadataResponseMessageType: Gets an opaque authentication token that identifies a sharing invitation.
GetStreamingEvents() : GetStreamingEventsResponseType: Requests notifications from the Client Access server.
GetUserAvailability() : GetUserAvailabilityResponseType: Provides detailed information about the availability of a set of users, rooms, and resources within a specified time period.
GetUserConfiguration() : GetUserConfigurationResponseType: Retrieves a user configuration object from a folder.
GetUserOofSettings() : GetUserOofSettingsResponse: Gets a mailbox user's Out of Office (OOF) settings and messages.
GetUserPhoto() : GetUserPhotoResponseMessageType: Retrieves a user photo from Active Directory Domain Services (AD DS).
GetUserRetentionPolicyTags() : GetUserRetentionPolicyTagsResponseMessageType: Retrieves a list of all default, system folder, and personal tags that are associated with a user by means of a system policy or that were applied by the user.
InstallApp() : InstallAppResponseType: Installs a mail app for Outlook in a mailbox.
MarkAllItemsAsRead() : MarkAllItemsAsReadResponseType: Sets the IsRead property on all items, in one or more folders, to indicate that all items are either read or unread.
MarkAsJunk() : MarkAsJunkResponseType: Adds and removes users from the blocked email list and moves email messages to the Junk Email folder.
MoveFolder() : MoveFolderResponseType: Moves folders from a specified folder and puts them in another folder.
MoveItem() : MoveItemResponseType: Moves one or more items to a single destination folder.
PerformReminderAction() : PerformReminderActionResponseMessageType: Initiates a dismiss or snooze action on a reminder.
PlayOnPhone() : PlayOnPhoneResponseMessageType: Initiates an outbound call and plays a message over the telephone.
RefreshSharingFolder() : RefreshSharingFolderResponseMessageType: Refreshes the specified local folder with the latest data from the folder that is being shared.
RemoveContactFromImList() : RemoveContactFromImListResponseMessageType: Removes contacts from the Lync instant messaging (IM) list when Lync uses Exchange for the contact store.
RemoveDelegate() : RemoveDelegateResponseMessageType: Removes one or more delegates from a user's mailbox.
RemoveDistributionGroupFromImList() : RemoveDistributionGroupFromImListResponseMessageType: Removes a distribution group from the Lync instant messaging (IM) list when Lync uses Exchange for the contact store.
RemoveImContactFromGroup() : RemoveImContactFromGroupResponseMessageType: Removes a single IM contact from an IM group.
RemoveImGroup() : RemoveImGroupResponseMessageType: Removes a single instant messaging (IM) group from a mailbox.
ResolveNames() : ResolveNamesResponseType: Resolves ambiguous email addresses and display names.
SearchMailboxes() : SearchMailboxesResponseType: Searches mailboxes for occurrences of terms in mailbox items.
SendItem() : SendItemResponseType: Sends e-mail messages that are located in the Exchange store.
setCurlOptions() : mixed: Sets the cURL options that will be set on the SOAP client.
SetHoldOnMailboxes() : SetHoldOnMailboxesResponseMessageType: Sets a mailbox hold policy on mailboxes.
SetImGroup() : SetImGroupResponseMessageType: Changes the display name of an instant messaging (IM) group.
setImpersonation() : mixed: Sets the impersonation property
setPassword() : mixed: Sets the password property
setServer() : mixed: Sets the server property
setTimezone() : mixed: Sets the timezone to be used for all requests.
setUsername() : mixed: Sets the user name property
SetUserOofSettings() : SetUserOofSettingsResponse: Sets a mailbox user's Out of Office (OOF) settings and message.
setVersion() : mixed: Sets the version property
Subscribe() : SubscribeResponseType: Subscribes client applications to either push or pull notifications.
SyncFolderHierarchy() : SyncFolderHierarchyResponseType: Synchronizes folders between the computer that is running Microsoft Exchange Server and the client.
SyncFolderItems() : SyncFolderItemsResponseType: Synchronizes items between the Exchange server and the client.
UninstallApp() : UninstallAppResponseType: Uninstalls a mail app for Outlook.
Unsubscribe() : UnsubscribeResponseType: Ends a pull notification subscription.
UpdateDelegate() : UpdateDelegateResponseMessageType: Updates delegate permissions on a principal's mailbox.
UpdateFolder() : UpdateFolderResponseType: Modifies properties of an existing item in the Exchange store.
UpdateInboxRules() : UpdateInboxRulesResponseType: Updates the authenticated user's Inbox rules by applying the specified operations.
UpdateItem() : UpdateItemResponseType: Used to modify the properties of an existing item in the Exchange store.
UpdateUserConfiguration() : UpdateUserConfigurationResponseType: Updates a user configuration object on a folder.
UploadItems() : UploadItemsResponseType: Uploads a stream of items into an Exchange mailbox.
classMap() : array<string|int, string>: The class map used to process SOAP requests and responses.
initializeSoapClient() : SoapClient: Initializes the SoapClient object to make a request
makeRequest() : Response: Makes the SOAP call for a request.
processResponse() : stdClass: Process a response to verify that it succeeded and take the appropriate action
soapHeaders() : array<string|int, SoapHeader>: Builds the soap headers to be included with the request.

VERSION_2007

Microsoft Exchange 2007


    public
        string
    VERSION_2007
    = 'Exchange2007'

VERSION_2007_SP1

Microsoft Exchange 2007 SP1


    public
        string
    VERSION_2007_SP1
    = 'Exchange2007_SP1'

VERSION_2009

Microsoft Exchange 2007 SP2


    public
        string
    VERSION_2009
    = 'Exchange2009'

VERSION_2010

Microsoft Exchange 2010


    public
        string
    VERSION_2010
    = 'Exchange2010'

VERSION_2010_SP1

Microsoft Exchange 2010 SP1


    public
        string
    VERSION_2010_SP1
    = 'Exchange2010_SP1'

VERSION_2010_SP2

Microsoft Exchange 2010 SP2


    public
        string
    VERSION_2010_SP2
    = 'Exchange2010_SP2'

VERSION_2013

Microsoft Exchange 2013.


    public
        string
    VERSION_2013
    = 'Exchange2013'

VERSION_2013_SP1

Microsoft Exchange 2013 SP1.


    public
        string
    VERSION_2013_SP1
    = 'Exchange2013_SP1'

VERSION_2016

Microsoft Exchange 2016.


    public
        string
    VERSION_2016
    = 'Exchange2016'

$curl_options

cURL options to be passed to the SOAP client.


    protected
        array<string|int, mixed>
    $curl_options
     = array()

$headers

SOAP headers used for requests.


    protected
        array<string|int, SoapHeader>
    $headers
     = array()

$impersonation

Exchange impersonation


    protected
        ExchangeImpersonationType
    $impersonation

$password

Password to use when connecting to the Exchange server.


    protected
        string
    $password

$server

Location of the Exchange server.


    protected
        string
    $server

$soap

SOAP client used to make the request.


    protected
        null|SoapClient
    $soap

$timezone

Timezone to be used for all requests.


    protected
        string
    $timezone

$username

Username to use when connecting to the Exchange server.


    protected
        string
    $username

$version

Microsoft Exchange version that we are going to connect to


    protected
        string
    $version

__construct()

Constructor for the ExchangeWebServices class


    public
                    __construct([string $server = null ][, string $username = null ][, string $password = null ][, string $version = self::VERSION_2013 ]) : mixed

Parameters

$server : string = null
$username : string = null
$password : string = null
$version : string = self::VERSION_2013: One of the Client::VERSION_* constants.

AddDelegate()

Adds one or more delegates to a principal's mailbox and sets specific access permissions.


    public
                    AddDelegate(AddDelegateType $request) : AddDelegateResponseMessageType

Parameters

$request : AddDelegateType

Return values

AddDelegateResponseMessageType

AddDistributionGroupToImList()

Adds a distribution group to the instant messaging (IM) list in the Unified Contact Store.


    public
                    AddDistributionGroupToImList(AddDistributionGroupToImListType $request) : AddDistributionGroupToImListResponseMessageType

Parameters

$request : AddDistributionGroupToImListType

Return values

AddDistributionGroupToImListResponseMessageType

AddImContactToGroup()

Adds an existing instant messaging (IM) contact to a group.


    public
                    AddImContactToGroup(AddImContactToGroup $request) : AddImContactToGroupResponseMessageType

Parameters

$request : AddImContactToGroup

Return values

AddImContactToGroupResponseMessageType

AddImGroup()

Adds a new instant messaging (IM) group to a mailbox.


    public
                    AddImGroup(AddImGroupType $request) : AddImGroupResponseMessageType

Parameters

$request : AddImGroupType

Return values

AddImGroupResponseMessageType

AddNewImContactToGroup()

Adds a new contact to an instant messaging (IM) group.


    public
                    AddNewImContactToGroup(AddNewImContactToGroup $request) : AddNewImContactToGroupResponseMessageType

Parameters

$request : AddNewImContactToGroup

Return values

AddNewImContactToGroupResponseMessageType

AddNewTelUriContactToGroup()

Adds a new contact to a group based on a contact's phone number.


    public
                    AddNewTelUriContactToGroup(AddNewTelUriContactToGroupType $request) : AddNewTelUriContactToGroupResponse

Parameters

$request : AddNewTelUriContactToGroupType

Return values

AddNewTelUriContactToGroupResponse

ApplyConversationAction()

Sets a one-time or follow up action on all the items in a conversation.


    public
                    ApplyConversationAction(ApplyConversationActionType $request) : ApplyConversationActionResponseType

This operation allows you to categorize, move, copy, delete, and set the read state on all items in a conversation. Actions can also be set for new messages in a conversation.

Parameters

$request : ApplyConversationActionType

Return values

ApplyConversationActionResponseType

ArchiveItem()

Moves an item into the mailbox user's archive mailbox.


    public
                    ArchiveItem(ArchiveItemType $request) : ArchiveItemResponse

Parameters

$request : ArchiveItemType

Return values

ArchiveItemResponse

ConvertId()

Converts item and folder identifiers between formats that are accepted by Exchange Online, Exchange Online as part of Office 365, and on-premises versions of Exchange.


    public
                    ConvertId(ConvertIdType $request) : ConvertIdResponseType

Parameters

$request : ConvertIdType

Return values

ConvertIdResponseType

CopyFolder()

Copies folders in a mailbox.


    public
                    CopyFolder(CopyFolderType $request) : CopyFolderResponseType

Parameters

$request : CopyFolderType

Return values

CopyFolderResponseType

CopyItem()

Copies items and puts the items in a different folder.


    public
                    CopyItem(CopyItemType $request) : CopyItemResponseType

Parameters

$request : CopyItemType

Return values

CopyItemResponseType

CreateAttachment()

Creates either an item or file attachment and attaches it to the specified item.


    public
                    CreateAttachment(CreateAttachmentType $request) : CreateAttachmentResponseType

Parameters

$request : CreateAttachmentType

Return values

CreateAttachmentResponseType

CreateFolder()

Creates folders, calendar folders, contacts folders, tasks folders, and search folders.


    public
                    CreateFolder(CreateFolderType $request) : CreateFolderResponseType

Parameters

$request : CreateFolderType

Return values

CreateFolderResponseType

CreateFolderPath()

Creates a folder hierarchy.


    public
                    CreateFolderPath(CreateFolderPathType $request) : CreateFolderPathResponseType

Parameters

$request : CreateFolderPathType

Return values

CreateFolderPathResponseType

CreateItem()

Creates items in the Exchange store.


    public
                    CreateItem(CreateItemType $request) : CreateItemResponseType

Parameters

$request : CreateItemType

Return values

CreateItemResponseType

CreateManagedFolder()

Creates a managed folder in the Exchange store.


    public
                    CreateManagedFolder(CreateManagedFolderRequestType $request) : CreateManagedFolderResponseType

Parameters

$request : CreateManagedFolderRequestType

Return values

CreateManagedFolderResponseType

CreateUserConfiguration()

Creates a user configuration object on a folder.


    public
                    CreateUserConfiguration(CreateUserConfigurationType $request) : CreateUserConfigurationResponseType

Parameters

$request : CreateUserConfigurationType

Return values

CreateUserConfigurationResponseType

DeleteAttachment()

Deletes file and item attachments from an existing item in the Exchange store.


    public
                    DeleteAttachment(DeleteAttachmentType $request) : DeleteAttachmentResponseType

Parameters

$request : DeleteAttachmentType

Return values

DeleteAttachmentResponseType

DeleteFolder()

Deletes folders from a mailbox.


    public
                    DeleteFolder(DeleteFolderType $request) : DeleteFolderResponseType

Parameters

$request : DeleteFolderType

Return values

DeleteFolderResponseType

DeleteItem()

Deletes items in the Exchange store.


    public
                    DeleteItem(DeleteItemType $request) : DeleteItemResponseType

Parameters

$request : DeleteItemType

Return values

DeleteItemResponseType

DeleteUserConfiguration()

Deletes a user configuration object on a folder.


    public
                    DeleteUserConfiguration(DeleteUserConfigurationType $request) : DeleteUserConfigurationResponseType

Parameters

$request : DeleteUserConfigurationType

Return values

DeleteUserConfigurationResponseType

DisableApp()

Disables a mail app for Outlook.


    public
                    DisableApp(DisableAppType $request) : DisableAppResponseType

Parameters

$request : DisableAppType

Return values

DisableAppResponseType

DisconnectPhoneCall()

Terminates a telephone call.


    public
                    DisconnectPhoneCall(DisconnectPhoneCallType $request) : DisconnectPhoneCallResponseMessageType

Parameters

$request : DisconnectPhoneCallType

Return values

DisconnectPhoneCallResponseMessageType

EmptyFolder()

Empties folders in a mailbox.


    public
                    EmptyFolder(EmptyFolderType $request) : EmptyFolderResponseType

Optionally, this operation enables you to delete the subfolders of the specified folder. When a subfolder is deleted, the subfolder and the messages within the subfolder are deleted.

Parameters

$request : EmptyFolderType

Return values

EmptyFolderResponseType

ExpandDL()

Exposes the full membership of distribution lists.


    public
                    ExpandDL(ExpandDLType $request) : ExpandDLResponseType

Parameters

$request : ExpandDLType

Return values

ExpandDLResponseType

ExportItems()

Exports items out of a mailbox.


    public
                    ExportItems(ExportItemsType $request) : ExportItemsResponseType

Parameters

$request : ExportItemsType

Return values

ExportItemsResponseType

FindConversation()

Enumerates a list of conversations in a folder.


    public
                    FindConversation(FindConversationType $request) : FindConversationResponseMessageType

Parameters

$request : FindConversationType

Return values

FindConversationResponseMessageType

FindFolder()

Finds subfolders of an identified folder and returns a set of properties that describe the set of subfolders.


    public
                    FindFolder(FindFolderType $request) : FindFolderResponseType

Parameters

$request : FindFolderType

Return values

FindFolderResponseType

FindItem()

Searches for items that are located in a user’s mailbox.


    public
                    FindItem(FindItemType $request) : FindItemResponseType

This operation provides many ways to filter and format how search results are returned to the caller.

Parameters

$request : FindItemType

Return values

FindItemResponseType

FindMessageTrackingReport()

Finds messages that meet the specified criteria.


    public
                    FindMessageTrackingReport(FindMessageTrackingReportRequestType $request) : FindMessageTrackingReportResponseMessageType

Parameters

$request : FindMessageTrackingReportRequestType

Return values

FindMessageTrackingReportResponseMessageType

FindPeople()

Returns all persona objects from a specified Contacts folder or retrieves contacts that match a specified query string.


    public
                    FindPeople(FindPeopleType $request) : FindPeopleResponseMessageType

Parameters

$request : FindPeopleType

Return values

FindPeopleResponseMessageType

GetAppManifests()

Retrieves app manifests.


    public
                    GetAppManifests(GetAppManifestsType $request) : GetAppManifestsResponseType

Parameters

$request : GetAppManifestsType

Return values

GetAppManifestsResponseType

GetAppMarketplaceUrl()

Retrieves the URL for the app marketplace that a client can visit to acquire apps to install in a mailbox.


    public
                    GetAppMarketplaceUrl(GetAppMarketplaceUrl $request) : GetAppMarketplaceUrlResponseMessageType

Parameters

$request : GetAppMarketplaceUrl

Return values

GetAppMarketplaceUrlResponseMessageType

GetAttachment()

Retrieves existing attachments on items in the Exchange store.


    public
                    GetAttachment(GetAttachmentType $request) : GetAttachmentResponseType

Parameters

$request : GetAttachmentType

Return values

GetAttachmentResponseType

getClient()

Returns the SOAP Client that may be used to make calls against the server


    public
                    getClient() : SoapClient

Return values

SoapClient

GetClientAccessToken()

Gets a client access token for a mail app for Outlook.


    public
                    GetClientAccessToken(GetClientAccessTokenType $request) : GetClientAccessTokenResponseType

Parameters

$request : GetClientAccessTokenType

Return values

GetClientAccessTokenResponseType

GetConversationItems()

Retrieves one or more sets of items that are organized in to nodes in a conversation.


    public
                    GetConversationItems(GetConversationItemsType $request) : GetConversationItemsResponseType

Parameters

$request : GetConversationItemsType

Return values

GetConversationItemsResponseType

GetDelegate()

Retrieves the delegate settings for a specified mailbox.


    public
                    GetDelegate(GetDelegateType $request) : GetDelegateResponseMessageType

Parameters

$request : GetDelegateType

Return values

GetDelegateResponseMessageType

GetDiscoverySearchConfiguration()

Returns configuration information for in-place holds, saved discovery searches, and the mailboxes that are enabled for discovery search.


    public
                    GetDiscoverySearchConfiguration(GetDiscoverySearchConfigurationType $request) : GetDiscoverySearchConfigurationResponseMessageType

Parameters

$request : GetDiscoverySearchConfigurationType

Return values

GetDiscoverySearchConfigurationResponseMessageType

GetEvents()

Used by pull subscription clients to request notifications from the Client Access server.


    public
                    GetEvents(GetEventsType $request) : GetEventsResponseType

The response returns an array of items and events that have occurred in a mailbox since the last the notification.

Parameters

$request : GetEventsType

Return values

GetEventsResponseType

GetFolder()

Gets folders from the Exchange store.


    public
                    GetFolder(GetFolderType $request) : GetFolderResponseType

Parameters

$request : GetFolderType

Return values

GetFolderResponseType

GetHoldOnMailboxes()

Retrieves the mailboxes that are under a specific hold and the associated hold query.


    public
                    GetHoldOnMailboxes(GetHoldOnMailboxesType $request) : GetHoldOnMailboxesResponseMessageType

Parameters

$request : GetHoldOnMailboxesType

Return values

GetHoldOnMailboxesResponseMessageType

GetImItemList()

Retrieves the list of instant messaging (IM) groups and IM contact personas in a mailbox.


    public
                    GetImItemList(GetImItemListType $request) : GetImItemListResponseMessageType

Parameters

$request : GetImItemListType

Return values

GetImItemListResponseMessageType

GetImItems()

Retrieves information about instant messaging (IM) groups and IM contact personas.


    public
                    GetImItems(GetImItemsType $request) : GetImItemsResponse

Parameters

$request : GetImItemsType

Return values

GetImItemsResponse

GetInboxRules()

Retrieves Inbox rules in the identified user's mailbox.


    public
                    GetInboxRules(GetInboxRulesRequestType $request) : GetInboxRulesResponseType

Parameters

$request : GetInboxRulesRequestType

Return values

GetInboxRulesResponseType

GetItem()

Gets folders from the Exchange store.


    public
                    GetItem(GetItemType $request) : GetItemResponseType

Parameters

$request : GetItemType

Return values

GetItemResponseType

GetMailTips()

Retrieves the mail tips information for the specified mailbox.


    public
                    GetMailTips(GetMailTipsType $request) : GetMailTipsResponseMessageType

Parameters

$request : GetMailTipsType

Return values

GetMailTipsResponseMessageType

GetMessageTrackingReport()

Retrieves tracking information about the specified messages.


    public
                    GetMessageTrackingReport(GetMessageTrackingReportRequestType $request) : GetMessageTrackingReportResponseMessageType

Parameters

$request : GetMessageTrackingReportRequestType

Return values

GetMessageTrackingReportResponseMessageType

GetNonIndexableItemDetails()

Retrieves details about items that cannot be indexed.


    public
                    GetNonIndexableItemDetails(GetNonIndexableItemDetailsType $request) : GetNonIndexableItemDetailsResponseMessageType

This includes, but is not limited to, the item identifier, an error code, an error description, when an attempt was made to index the item, and additional information about the file.

Parameters

$request : GetNonIndexableItemDetailsType

Return values

GetNonIndexableItemDetailsResponseMessageType

GetNonIndexableItemStatistics()

Retrieves the count of items that cannot be indexed in a mailbox.


    public
                    GetNonIndexableItemStatistics(GetNonIndexableItemStatisticsType $request) : GetNonIndexableItemStatisticsResponseMessageType

Parameters

$request : GetNonIndexableItemStatisticsType

Return values

GetNonIndexableItemStatisticsResponseMessageType

GetPasswordExpirationDate()

Provides the email account password expiration date for the current user.


    public
                    GetPasswordExpirationDate(GetPasswordExpirationDateType $request) : GetPasswordExpirationDateResponseMessageType

Parameters

$request : GetPasswordExpirationDateType

Return values

GetPasswordExpirationDateResponseMessageType

GetPersona()

Retrieves a set of properties that are associated with a persona.


    public
                    GetPersona(GetPersonaType $request) : GetPersonaResponseMessageType

Parameters

$request : GetPersonaType

Return values

GetPersonaResponseMessageType

GetPhoneCallInformation()

Retrieves information about the specified telephone call.


    public
                    GetPhoneCallInformation(GetPhoneCallInformationType $request) : GetPhoneCallInformationResponseMessageType

Parameters

$request : GetPhoneCallInformationType

Return values

GetPhoneCallInformationResponseMessageType

GetReminders()

Retrieves reminders for calendar and task items.


    public
                    GetReminders(GetRemindersType $request) : GetRemindersResponseMessageType

Parameters

$request : GetRemindersType

Return values

GetRemindersResponseMessageType

GetRoomLists()

Retrieves the room lists that are available within the Exchange organization.


    public
                    GetRoomLists(GetRoomListsType $request) : GetRoomListsResponseMessageType

Parameters

$request : GetRoomListsType

Return values

GetRoomListsResponseMessageType

GetRooms()

Retrieves the rooms within the specified room list.


    public
                    GetRooms(GetRoomsType $request) : GetRoomsResponseMessageType

Parameters

$request : GetRoomsType

Return values

GetRoomsResponseMessageType

GetSearchableMailboxes()

Retrieves a scoped set of searchable mailboxes for discovery searches.


    public
                    GetSearchableMailboxes(GetSearchableMailboxesType $request) : GetSearchableMailboxesResponseMessageType

The scope of searchable mailboxes returned in the response is determined by the search filter and whether distribution group membership is expanded.

Parameters

$request : GetSearchableMailboxesType

Return values

GetSearchableMailboxesResponseMessageType

GetServerTimeZones()

Retrieve the timezones supported by the server.


    public
                    GetServerTimeZones(GetServerTimeZonesType $request) : GetServerTimeZonesResponseType

Parameters

$request : GetServerTimeZonesType

Return values

GetServerTimeZonesResponseType

GetServiceConfiguration()

Retrieves configuration information for the specified type of service.


    public
                    GetServiceConfiguration(GetServiceConfigurationType $request) : GetServiceConfigurationResponseMessageType

This operation can return configuration settings for the Unified Messaging, Protection Rules, and Mail Tips services.

Parameters

$request : GetServiceConfigurationType

Return values

GetServiceConfigurationResponseMessageType

GetSharingFolder()

Retrieves the local folder identifier of a specified shared folder.


    public
                    GetSharingFolder(GetSharingFolderType $request) : GetSharingFolderResponseMessageType

Parameters

$request : GetSharingFolderType

Return values

GetSharingFolderResponseMessageType

GetSharingMetadata()

Gets an opaque authentication token that identifies a sharing invitation.


    public
                    GetSharingMetadata(GetSharingMetadataType $request) : GetSharingMetadataResponseMessageType

Parameters

$request : GetSharingMetadataType

Return values

GetSharingMetadataResponseMessageType

GetStreamingEvents()

Requests notifications from the Client Access server.


    public
                    GetStreamingEvents(GetStreamingEventsType $request) : GetStreamingEventsResponseType

The GetStreamingEvents response returns an array of items and events that have occurred in a mailbox since the last the notification.

Parameters

$request : GetStreamingEventsType

Return values

GetStreamingEventsResponseType

GetUserAvailability()

Provides detailed information about the availability of a set of users, rooms, and resources within a specified time period.


    public
                    GetUserAvailability(GetUserAvailabilityRequestType $request) : GetUserAvailabilityResponseType

Parameters

$request : GetUserAvailabilityRequestType

Return values

GetUserAvailabilityResponseType

GetUserConfiguration()

Retrieves a user configuration object from a folder.


    public
                    GetUserConfiguration(GetUserConfigurationType $request) : GetUserConfigurationResponseType

Parameters

$request : GetUserConfigurationType

Return values

GetUserConfigurationResponseType

GetUserOofSettings()

Gets a mailbox user's Out of Office (OOF) settings and messages.


    public
                    GetUserOofSettings(GetUserOofSettingsRequest $request) : GetUserOofSettingsResponse

Parameters

$request : GetUserOofSettingsRequest

Return values

GetUserOofSettingsResponse

GetUserPhoto()

Retrieves a user photo from Active Directory Domain Services (AD DS).


    public
                    GetUserPhoto(GetUserPhotoType $request) : GetUserPhotoResponseMessageType

Parameters

$request : GetUserPhotoType

Return values

GetUserPhotoResponseMessageType

GetUserRetentionPolicyTags()

Retrieves a list of all default, system folder, and personal tags that are associated with a user by means of a system policy or that were applied by the user.


    public
                    GetUserRetentionPolicyTags(GetUserRetentionPolicyTagsType $request) : GetUserRetentionPolicyTagsResponseMessageType

Parameters

$request : GetUserRetentionPolicyTagsType

Return values

GetUserRetentionPolicyTagsResponseMessageType

InstallApp()

Installs a mail app for Outlook in a mailbox.


    public
                    InstallApp(InstallAppType $request) : InstallAppResponseType

Parameters

$request : InstallAppType

Return values

InstallAppResponseType

MarkAllItemsAsRead()

Sets the IsRead property on all items, in one or more folders, to indicate that all items are either read or unread.


    public
                    MarkAllItemsAsRead(MarkAllItemsAsRead $request) : MarkAllItemsAsReadResponseType

Parameters

$request : MarkAllItemsAsRead

Return values

MarkAllItemsAsReadResponseType

MarkAsJunk()

Adds and removes users from the blocked email list and moves email messages to the Junk Email folder.


    public
                    MarkAsJunk(MarkAsJunkType $request) : MarkAsJunkResponseType

Parameters

$request : MarkAsJunkType

Return values

MarkAsJunkResponseType

MoveFolder()

Moves folders from a specified folder and puts them in another folder.


    public
                    MoveFolder(MoveFolderType $request) : MoveFolderResponseType

Parameters

$request : MoveFolderType

Return values

MoveFolderResponseType

MoveItem()

Moves one or more items to a single destination folder.


    public
                    MoveItem(MoveItemType $request) : MoveItemResponseType

Parameters

$request : MoveItemType

Return values

MoveItemResponseType

PerformReminderAction()

Initiates a dismiss or snooze action on a reminder.


    public
                    PerformReminderAction(PerformReminderActionType $request) : PerformReminderActionResponseMessageType

Parameters

$request : PerformReminderActionType

Return values

PerformReminderActionResponseMessageType

PlayOnPhone()

Initiates an outbound call and plays a message over the telephone.


    public
                    PlayOnPhone(PlayOnPhoneType $request) : PlayOnPhoneResponseMessageType

Parameters

$request : PlayOnPhoneType

Return values

PlayOnPhoneResponseMessageType

RefreshSharingFolder()

Refreshes the specified local folder with the latest data from the folder that is being shared.


    public
                    RefreshSharingFolder(RefreshSharingFolderType $request) : RefreshSharingFolderResponseMessageType

Parameters

$request : RefreshSharingFolderType

Return values

RefreshSharingFolderResponseMessageType

RemoveContactFromImList()

Removes contacts from the Lync instant messaging (IM) list when Lync uses Exchange for the contact store.


    public
                    RemoveContactFromImList(RemoveContactFromImListType $request) : RemoveContactFromImListResponseMessageType

Parameters

$request : RemoveContactFromImListType

Return values

RemoveContactFromImListResponseMessageType

RemoveDelegate()

Removes one or more delegates from a user's mailbox.


    public
                    RemoveDelegate(RemoveDelegateType $request) : RemoveDelegateResponseMessageType

Parameters

$request : RemoveDelegateType

Return values

RemoveDelegateResponseMessageType

RemoveDistributionGroupFromImList()

Removes a distribution group from the Lync instant messaging (IM) list when Lync uses Exchange for the contact store.


    public
                    RemoveDistributionGroupFromImList(RemoveDistributionGroupFromImListType $request) : RemoveDistributionGroupFromImListResponseMessageType

Parameters

$request : RemoveDistributionGroupFromImListType

Return values

RemoveDistributionGroupFromImListResponseMessageType

RemoveImContactFromGroup()

Removes a single IM contact from an IM group.


    public
                    RemoveImContactFromGroup(RemoveImContactFromGroupType $request) : RemoveImContactFromGroupResponseMessageType

Parameters

$request : RemoveImContactFromGroupType

Return values

RemoveImContactFromGroupResponseMessageType

RemoveImGroup()

Removes a single instant messaging (IM) group from a mailbox.


    public
                    RemoveImGroup(RemoveImGroupType $request) : RemoveImGroupResponseMessageType

Parameters

$request : RemoveImGroupType

Return values

RemoveImGroupResponseMessageType

ResolveNames()

Resolves ambiguous email addresses and display names.


    public
                    ResolveNames(ResolveNamesType $request) : ResolveNamesResponseType

Parameters

$request : ResolveNamesType

Return values

ResolveNamesResponseType

SearchMailboxes()

Searches mailboxes for occurrences of terms in mailbox items.


    public
                    SearchMailboxes(SearchMailboxesType $request) : SearchMailboxesResponseType

Parameters

$request : SearchMailboxesType

Return values

SearchMailboxesResponseType

SendItem()

Sends e-mail messages that are located in the Exchange store.


    public
                    SendItem(SendItemType $request) : SendItemResponseType

Parameters

$request : SendItemType

Return values

SendItemResponseType

setCurlOptions()

Sets the cURL options that will be set on the SOAP client.


    public
                    setCurlOptions(array<string|int, mixed> $options) : mixed

Parameters

$options : array<string|int, mixed>

SetHoldOnMailboxes()

Sets a mailbox hold policy on mailboxes.


    public
                    SetHoldOnMailboxes(SetHoldOnMailboxesType $request) : SetHoldOnMailboxesResponseMessageType

Parameters

$request : SetHoldOnMailboxesType

Return values

SetHoldOnMailboxesResponseMessageType

SetImGroup()

Changes the display name of an instant messaging (IM) group.


    public
                    SetImGroup(SetImGroupType $request) : SetImGroupResponseMessageType

Parameters

$request : SetImGroupType

Return values

SetImGroupResponseMessageType

setImpersonation()

Sets the impersonation property


    public
                    setImpersonation(ExchangeImpersonationType $impersonation) : mixed

Parameters

$impersonation : ExchangeImpersonationType

setPassword()

Sets the password property


    public
                    setPassword(string $password) : mixed

Parameters

$password : string

setServer()

Sets the server property


    public
                    setServer(string $server) : mixed

Parameters

$server : string

setTimezone()

Sets the timezone to be used for all requests.


    public
                    setTimezone(string $timezone) : mixed

Parameters

$timezone : string

setUsername()

Sets the user name property


    public
                    setUsername(string $username) : mixed

Parameters

$username : string

SetUserOofSettings()

Sets a mailbox user's Out of Office (OOF) settings and message.


    public
                    SetUserOofSettings(SetUserOofSettingsRequest $request) : SetUserOofSettingsResponse

Parameters

$request : SetUserOofSettingsRequest

Return values

SetUserOofSettingsResponse

setVersion()

Sets the version property


    public
                    setVersion(string $version) : mixed

Parameters

$version : string

Subscribe()

Subscribes client applications to either push or pull notifications.


    public
                    Subscribe(SubscribeType $request) : SubscribeResponseType

It is important to be aware that the structure of the request messages and responses is different depending on the type of event notification.

Parameters

$request : SubscribeType

Return values

SubscribeResponseType

SyncFolderHierarchy()

Synchronizes folders between the computer that is running Microsoft Exchange Server and the client.


    public
                    SyncFolderHierarchy(SyncFolderHierarchyType $request) : SyncFolderHierarchyResponseType

Parameters

$request : SyncFolderHierarchyType

Return values

SyncFolderHierarchyResponseType

SyncFolderItems()

Synchronizes items between the Exchange server and the client.


    public
                    SyncFolderItems(SyncFolderItemsType $request) : SyncFolderItemsResponseType

Parameters

$request : SyncFolderItemsType

Return values

SyncFolderItemsResponseType

UninstallApp()

Uninstalls a mail app for Outlook.


    public
                    UninstallApp(UninstallAppType $request) : UninstallAppResponseType

Parameters

$request : UninstallAppType

Return values

UninstallAppResponseType

Unsubscribe()

Ends a pull notification subscription.


    public
                    Unsubscribe(UnsubscribeType $request) : UnsubscribeResponseType

Use this operation rather than letting a subscription timeout. This operation is only valid for pull notifications.

Parameters

$request : UnsubscribeType

Return values

UnsubscribeResponseType

UpdateDelegate()

Updates delegate permissions on a principal's mailbox.


    public
                    UpdateDelegate(UpdateDelegateType $request) : UpdateDelegateResponseMessageType

Parameters

$request : UpdateDelegateType

Return values

UpdateDelegateResponseMessageType

UpdateFolder()

Modifies properties of an existing item in the Exchange store.


    public
                    UpdateFolder(UpdateFolderType $request) : UpdateFolderResponseType

Each UpdateFolder operation consists of the following:

A FolderId element that specifies a folder to update.
An internal path of an element in the folder, as specified by the folder shape, which specifies the data to update.
A folder that contains the new value of the updated field, if the update is not a deletion.

Parameters

$request : UpdateFolderType

Return values

UpdateFolderResponseType

UpdateInboxRules()

Updates the authenticated user's Inbox rules by applying the specified operations.


    public
                    UpdateInboxRules(UpdateInboxRulesRequestType $request) : UpdateInboxRulesResponseType

This operation is used to create an Inbox rule, to set an Inbox rule, or to delete an Inbox rule.

Parameters

$request : UpdateInboxRulesRequestType

Return values

UpdateInboxRulesResponseType

UpdateItem()

Used to modify the properties of an existing item in the Exchange store.


    public
                    UpdateItem(UpdateItemType $request) : UpdateItemResponseType

Parameters

$request : UpdateItemType

Return values

UpdateItemResponseType

UpdateUserConfiguration()

Updates a user configuration object on a folder.


    public
                    UpdateUserConfiguration(UpdateUserConfigurationType $request) : UpdateUserConfigurationResponseType

Parameters

$request : UpdateUserConfigurationType

Return values

UpdateUserConfigurationResponseType

UploadItems()

Uploads a stream of items into an Exchange mailbox.


    public
                    UploadItems(UploadItemsType $request) : UploadItemsResponseType

Parameters

$request : UploadItemsType

Return values

UploadItemsResponseType

classMap()

The class map used to process SOAP requests and responses.


    protected
                    classMap() : array<string|int, string>

Return values

array<string|int, string>

initializeSoapClient()

Initializes the SoapClient object to make a request


    protected
                    initializeSoapClient() : SoapClient

Return values

SoapClient

makeRequest()

Makes the SOAP call for a request.


    protected
                    makeRequest(string $operation, Request $request) : Response

Parameters

$operation : string: The operation to be called.
$request : Request: The request object for the operation.

Return values

Response —

The response object for the operation.

processResponse()

Process a response to verify that it succeeded and take the appropriate action


    protected
                    processResponse(stdClass $response) : stdClass

Parameters

$response : stdClass

Return values

stdClass

soapHeaders()

Builds the soap headers to be included with the request.


    protected
                    soapHeaders() : array<string|int, SoapHeader>

Return values

array<string|int, SoapHeader>

Client in package php ews Client

Tags

Table of Contents

Constants

Properties

Methods

Constants

VERSION_2007

VERSION_2007_SP1

VERSION_2009

VERSION_2010

VERSION_2010_SP1

VERSION_2010_SP2

VERSION_2013

VERSION_2013_SP1

VERSION_2016

Properties

$curl_options

$headers

$impersonation

$password

$server

$soap

$timezone

$username

$version

Tags

Methods

__construct()

Parameters

AddDelegate()

Parameters

Tags

Return values

AddDistributionGroupToImList()

Parameters

Tags

Return values

AddImContactToGroup()

Parameters

Tags

Return values

AddImGroup()

Parameters

Tags

Return values

AddNewImContactToGroup()

Parameters

Tags

Return values

AddNewTelUriContactToGroup()

Parameters

Tags

Return values

ApplyConversationAction()

Parameters

Tags

Return values

ArchiveItem()

Parameters

Tags

Return values

ConvertId()

Parameters

Tags

Return values

CopyFolder()

Parameters

Tags

Return values

CopyItem()

Parameters

Tags

Return values

CreateAttachment()

Parameters

Tags

Return values

CreateFolder()

Parameters

Client
in package

php

ews

Client