Overview

Packages

  • ActiveSync
  • None

Classes

  • Horde_ActiveSync
  • Horde_ActiveSync_Connector_Exporter
  • Horde_ActiveSync_Connector_Importer
  • Horde_ActiveSync_Driver_Base
  • Horde_ActiveSync_Exception
  • Horde_ActiveSync_Exception_InvalidRequest
  • Horde_ActiveSync_Exception_StateGone
  • Horde_ActiveSync_Message_Base
  • Horde_ActiveSync_Request_Base
  • Horde_ActiveSync_Request_FolderCreate
  • Horde_ActiveSync_Request_FolderSync
  • Horde_ActiveSync_Request_GetHierarchy
  • Horde_ActiveSync_Request_GetItemEstimate
  • Horde_ActiveSync_Request_MeetingResponse
  • Horde_ActiveSync_Request_MoveItems
  • Horde_ActiveSync_Request_Notify
  • Horde_ActiveSync_Request_Ping
  • Horde_ActiveSync_Request_Provision
  • Horde_ActiveSync_Request_Search
  • Horde_ActiveSync_Request_SendMail
  • Horde_ActiveSync_Request_SmartForward
  • Horde_ActiveSync_Request_SmartReply
  • Horde_ActiveSync_Request_Sync
  • Horde_ActiveSync_State_File
  • Horde_ActiveSync_Sync
  • Horde_ActiveSync_Wbxml
  • Horde_ActiveSync_Wbxml_Decoder
  • Horde_ActiveSync_Wbxml_Encoder
  • Overview
  • Package
  • Class
  • Tree

Class Horde_ActiveSync

Main ActiveSync class. Entry point for performing all ActiveSync operations

Located at Horde/ActiveSync.php
Methods summary
public Horde_ActiveSync
# __construct( Horde_ActiveSync_Driver_Base $driver, Horde_ActiveSync_Wbxml_Decoder $decoder, Horde_ActiveSync_Wbxml_Encoder $encoder, Horde_Controller_Request_Http $request )

Const'r

Const'r

Parameters

$driver
The backend driver
$decoder
$state The state machine
$encoder
$decoder The Wbxml decoder
$request
$encdoer The Wbxml encoder

Returns

Horde_ActiveSync
public
# setLogger( Horde_Log_Logger $logger )

Setter for the logger

Setter for the logger

Parameters

$logger
The logger object.
public
# setProvisioning( mixed $provision )

Setter for provisioning support

Setter for provisioning support
public static
# provisioningRequired( )
public boolean
# handleRequest( string $cmd, string $devId )

The heart of the server. Dispatch a request to the appropriate request handler.

The heart of the server. Dispatch a request to the appropriate request handler.

Parameters

$cmd
The command we are requesting.
$devId
The device id making the request.

Returns

boolean
public static
# activeSyncHeader( )

Send the MS_Server-ActiveSync header (This is the version Exchange 2003 advertises)

Send the MS_Server-ActiveSync header (This is the version Exchange 2003 advertises)
public static
# versionHeader( )

Send the protocol versions header

Send the protocol versions header
public static
# commandsHeader( )

Send protocol commands header. This contains appropriate command for ActiveSync version 2.5 support.

Send protocol commands header. This contains appropriate command for ActiveSync version 2.5 support.
public static
# provisionHeader( )

Send provision header

Send provision header
public integer
# getPolicyKey( )

Obtain the policy key header from the request.

Obtain the policy key header from the request.

Returns

integer
The policy key or '0' if not set.
public string
# getProtocolVersion( )

Obtain the ActiveSync protocol version

Obtain the ActiveSync protocol version

Returns

string
Constants summary
integer CONFLICT_OVERWRITE_SERVER
# 0
integer CONFLICT_OVERWRITE_PIM
# 1
integer BACKEND_DISCARD_DATA
# 1
integer TRUNCATION_HEADERS
# 0
integer TRUNCATION_512B
# 1
integer TRUNCATION_1K
# 2
integer TRUNCATION_5K
# 4
integer TRUNCATION_SEVEN
# 7
integer TRUNCATION_ALL
# 9
string FOLDERHIERARCHY_FOLDERS
# 'FolderHierarchy:Folders'
string FOLDERHIERARCHY_FOLDER
# 'FolderHierarchy:Folder'
string FOLDERHIERARCHY_DISPLAYNAME
# 'FolderHierarchy:DisplayName'
string FOLDERHIERARCHY_SERVERENTRYID
# 'FolderHierarchy:ServerEntryId'
string FOLDERHIERARCHY_PARENTID
# 'FolderHierarchy:ParentId'
string FOLDERHIERARCHY_TYPE
# 'FolderHierarchy:Type'
string FOLDERHIERARCHY_RESPONSE
# 'FolderHierarchy:Response'
string FOLDERHIERARCHY_STATUS
# 'FolderHierarchy:Status'
string FOLDERHIERARCHY_CONTENTCLASS
# 'FolderHierarchy:ContentClass'
string FOLDERHIERARCHY_CHANGES
# 'FolderHierarchy:Changes'
string FOLDERHIERARCHY_ADD
# 'FolderHierarchy:Add'
string FOLDERHIERARCHY_REMOVE
# 'FolderHierarchy:Remove'
string FOLDERHIERARCHY_UPDATE
# 'FolderHierarchy:Update'
string FOLDERHIERARCHY_SYNCKEY
# 'FolderHierarchy:SyncKey'
string FOLDERHIERARCHY_FOLDERCREATE
# 'FolderHierarchy:FolderCreate'
string FOLDERHIERARCHY_FOLDERDELETE
# 'FolderHierarchy:FolderDelete'
string FOLDERHIERARCHY_FOLDERUPDATE
# 'FolderHierarchy:FolderUpdate'
string FOLDERHIERARCHY_FOLDERSYNC
# 'FolderHierarchy:FolderSync'
string FOLDERHIERARCHY_COUNT
# 'FolderHierarchy:Count'
string FOLDERHIERARCHY_VERSION
# 'FolderHierarchy:Version'
string SYNC_SYNCHRONIZE
# 'Synchronize'
string SYNC_REPLIES
# 'Replies'
string SYNC_ADD
# 'Add'
string SYNC_MODIFY
# 'Modify'
string SYNC_REMOVE
# 'Remove'
string SYNC_FETCH
# 'Fetch'
string SYNC_SYNCKEY
# 'SyncKey'
string SYNC_CLIENTENTRYID
# 'ClientEntryId'
string SYNC_SERVERENTRYID
# 'ServerEntryId'
string SYNC_STATUS
# 'Status'
string SYNC_FOLDER
# 'Folder'
string SYNC_FOLDERTYPE
# 'FolderType'
string SYNC_VERSION
# 'Version'
string SYNC_FOLDERID
# 'FolderId'
string SYNC_GETCHANGES
# 'GetChanges'
string SYNC_MOREAVAILABLE
# 'MoreAvailable'
string SYNC_WINDOWSIZE
# 'WindowSize'
string SYNC_COMMANDS
# 'Commands'
string SYNC_OPTIONS
# 'Options'
string SYNC_FILTERTYPE
# 'FilterType'
string SYNC_TRUNCATION
# 'Truncation'
string SYNC_RTFTRUNCATION
# 'RtfTruncation'
string SYNC_CONFLICT
# 'Conflict'
string SYNC_FOLDERS
# 'Folders'
string SYNC_DATA
# 'Data'
string SYNC_DELETESASMOVES
# 'DeletesAsMoves'
string SYNC_NOTIFYGUID
# 'NotifyGUID'
string SYNC_SUPPORTED
# 'Supported'
string SYNC_SOFTDELETE
# 'SoftDelete'
string SYNC_MIMESUPPORT
# 'MIMESupport'
string SYNC_MIMETRUNCATION
# 'MIMETruncation'
string PROVISION_PROVISION
# 'Provision:Provision'
string PROVISION_POLICIES
# 'Provision:Policies'
string PROVISION_POLICY
# 'Provision:Policy'
string PROVISION_POLICYTYPE
# 'Provision:PolicyType'
string PROVISION_POLICYKEY
# 'Provision:PolicyKey'
string PROVISION_DATA
# 'Provision:Data'
string PROVISION_STATUS
# 'Provision:Status'
string PROVISION_REMOTEWIPE
# 'Provision:RemoteWipe'
string PROVISION_EASPROVISIONDOC
# 'Provision:EASProvisionDoc'
string FLAG_NEWMESSAGE
# 'NewMessage'
integer FOLDER_TYPE_OTHER
# 1
integer FOLDER_TYPE_INBOX
# 2
integer FOLDER_TYPE_DRAFTS
# 3
integer FOLDER_TYPE_WASTEBASKET
# 4
integer FOLDER_TYPE_SENTMAIL
# 5
integer FOLDER_TYPE_OUTBOX
# 6
integer FOLDER_TYPE_TASK
# 7
integer FOLDER_TYPE_APPOINTMENT
# 8
integer FOLDER_TYPE_CONTACT
# 9
integer FOLDER_TYPE_NOTE
# 10
integer FOLDER_TYPE_JOURNAL
# 11
integer FOLDER_TYPE_USER_MAIL
# 12
integer FOLDER_TYPE_USER_APPOINTMENT
# 13
integer FOLDER_TYPE_USER_CONTACT
# 14
integer FOLDER_TYPE_USER_TASK
# 15
integer FOLDER_TYPE_USER_JOURNAL
# 16
integer FOLDER_TYPE_USER_NOTE
# 17
integer FOLDER_TYPE_UNKNOWN
# 18
integer FOLDER_TYPE_RECIPIENT_CACHE
# 19
string FOLDER_TYPE_DUMMY
# '__dummy.Folder.Id__'
integer CHANGE_ORIGIN_PIM

Origin of changes *

Origin of changes *
# 0
integer CHANGE_ORIGIN_SERVER
# 1
integer CHANGE_ORIGIN_NA
# 3
integer RWSTATUS_NA

Remote wipe *

Remote wipe *
# 0
integer RWSTATUS_OK
# 1
integer RWSTATUS_PENDING
# 2
integer RWSTATUS_WIPED
# 3
string GAL_DISPLAYNAME

GAL *

GAL *
# 'GAL:DisplayName'
string GAL_PHONE
# 'GAL:Phone'
string GAL_OFFICE
# 'GAL:Office'
string GAL_TITLE
# 'GAL:Title'
string GAL_COMPANY
# 'GAL:Company'
string GAL_ALIAS
# 'GAL:Alias'
string GAL_FIRSTNAME
# 'GAL:FirstName'
string GAL_LASTNAME
# 'GAL:LastName'
string GAL_HOMEPHONE
# 'GAL:HomePhone'
string GAL_MOBILEPHONE
# 'GAL:MobilePhone'
string GAL_EMAILADDRESS
# 'GAL:EmailAddress'
string PROVISIONING_LOOSE
# 'loose'
API documentation generated by ApiGen