Documentation

Horde_ActiveSync

in package

• ActiveSync

The Horde ActiveSync server. Entry point for performing all ActiveSync operations.

Tags

license

http://www.horde.org/licenses/gpl GPLv2

copyright

2009-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

AIRSYNCBASE_ACCURACY  = 'AirSyncBase:Accuracy'

AIRSYNCBASE_ADD  = 'AirSyncBase:Add'

AIRSYNCBASE_ALLORNONE  = 'AirSyncBase:AllOrNone'

AIRSYNCBASE_ALTITUDE  = 'AirSyncBase:Altitude'

AIRSYNCBASE_ALTITUDEACCURACY  = 'AirSyncBase:AltitudeAccuracy'

AIRSYNCBASE_ANNOTATION  = 'AirSyncBase:Annotation'

AIRSYNCBASE_ATTACHMENT  = 'AirSyncBase:Attachment'

AIRSYNCBASE_ATTACHMENTS  = 'AirSyncBase:Attachments'

AIRSYNCBASE_BODY  = 'AirSyncBase:Body'

AIRSYNCBASE_BODYPART  = 'AirSyncBase:BodyPart'

AIRSYNCBASE_BODYPARTPREFERENCE  = 'AirSyncBase:BodyPartPreference'

AIRSYNCBASE_BODYPREFERENCE  = 'AirSyncBase:BodyPreference'

AIRSYNCBASE_CITY  = 'AirSyncBase:City'

AIRSYNCBASE_CLIENTID  = 'AirSyncBase:ClientId'

AIRSYNCBASE_CONTENT  = 'AirSyncBase:Content'

AIRSYNCBASE_CONTENTID  = 'AirSyncBase:ContentId'

AIRSYNCBASE_CONTENTLOCATION  = 'AirSyncBase:ContentLocation'

AIRSYNCBASE_CONTENTTYPE  = 'AirSyncBase:ContentType'

AIRSYNCBASE_COUNTRY  = 'AirSyncBase:Country'

AIRSYNCBASE_DATA  = 'AirSyncBase:Data'

AIRSYNCBASE_DELETE  = 'AirSyncBase:Delete'

AIRSYNCBASE_DISPLAYNAME  = 'AirSyncBase:DisplayName'

AIRSYNCBASE_ESTIMATEDDATASIZE  = 'AirSyncBase:EstimatedDataSize'

AIRSYNCBASE_FILEREFERENCE  = 'AirSyncBase:FileReference'

AIRSYNCBASE_INSTANCEID  = 'AirSyncBase:InstanceId'

AIRSYNCBASE_ISINLINE  = 'AirSyncBase:IsInline'

AIRSYNCBASE_LATITUDE  = 'AirSyncBase:Latitude'

AIRSYNCBASE_LOCATION  = 'AirSyncBase:Location'

AIRSYNCBASE_LOCATIONURI  = 'AirSyncBase:LocationUri'

AIRSYNCBASE_LONGITUDE  = 'AirSyncBase:Longitude'

AIRSYNCBASE_METHOD  = 'AirSyncBase:Method'

AIRSYNCBASE_NATIVEBODYTYPE  = 'AirSyncBase:NativeBodyType'

AIRSYNCBASE_POSTALCODE  = 'AirSyncBase:PostalCode'

AIRSYNCBASE_PREVIEW  = 'AirSyncBase:Preview'

AIRSYNCBASE_STATE  = 'AirSyncBase:State'

AIRSYNCBASE_STATUS  = 'AirSyncBase:Status'

AIRSYNCBASE_STREET  = 'AirSyncBase:Street'

AIRSYNCBASE_TRUNCATED  = 'AirSyncBase:Truncated'

AIRSYNCBASE_TRUNCATIONSIZE  = 'AirSyncBase:TruncationSize'

AIRSYNCBASE_TYPE  = 'AirSyncBase:Type'

ALL_GHOSTED  = 'allghosted'

AUTH_REASON_DEVICE_DENIED  = 'device'

AUTH_REASON_USER_DENIED  = 'user'

BODYPREF_TYPE_HTML  = 2

BODYPREF_TYPE_MIME  = 4

BODYPREF_TYPE_PLAIN  = 1

BODYPREF_TYPE_RTF  = 3

CHANGE_FORWARD_STATE  = '@--forward--@'

CHANGE_ORIGIN_NA  = 3

CHANGE_ORIGIN_PIM  = 0

CHANGE_ORIGIN_SERVER  = 1

CHANGE_REPLY_STATE  = '@--reply--@'

CHANGE_REPLYALL_STATE  = '@--replyall--@'

CHANGE_TYPE_CHANGE  = 'change'

CHANGE_TYPE_DELETE  = 'delete'

CHANGE_TYPE_DRAFT  = 'draft'

CHANGE_TYPE_FLAGS  = 'flags'

CHANGE_TYPE_FOLDERSYNC  = 'foldersync'

CHANGE_TYPE_MOVE  = 'move'

CHANGE_TYPE_SOFTDELETE  = 'softdelete'

CLASS_CALENDAR  = 'Calendar'

CLASS_CONTACTS  = 'Contacts'

CLASS_EMAIL  = 'Email'

CLASS_NOTES  = 'Notes'

CLASS_SMS  = 'SMS'

CLASS_TASKS  = 'Tasks'

CONFLICT_OVERWRITE_PIM  = 1

CONFLICT_OVERWRITE_SERVER  = 0

FILTERTYPE_1DAY  = 1

FILTERTYPE_1MONTH  = 5

FILTERTYPE_1WEEK  = 3

FILTERTYPE_2WEEKS  = 4

FILTERTYPE_3DAYS  = 2

FILTERTYPE_3MONTHS  = 6

FILTERTYPE_6MONTHS  = 7

FILTERTYPE_ALL  = 0

FILTERTYPE_INCOMPLETETASKS  = 8

FLAG_NEWMESSAGE  = 'NewMessage'

FOLDER_ROOT  = 0

FOLDER_TYPE_APPOINTMENT  = 8

FOLDER_TYPE_CONTACT  = 9

FOLDER_TYPE_DRAFTS  = 3

FOLDER_TYPE_DUMMY  = 999999

FOLDER_TYPE_INBOX  = 2

FOLDER_TYPE_JOURNAL  = 11

FOLDER_TYPE_NOTE  = 10

FOLDER_TYPE_OTHER  = 1

FOLDER_TYPE_OUTBOX  = 6

FOLDER_TYPE_RECIPIENT_CACHE  = 19

FOLDER_TYPE_SENTMAIL  = 5

FOLDER_TYPE_TASK  = 7

FOLDER_TYPE_UNKNOWN  = 18

FOLDER_TYPE_USER_APPOINTMENT  = 13

FOLDER_TYPE_USER_CONTACT  = 14

FOLDER_TYPE_USER_JOURNAL  = 16

FOLDER_TYPE_USER_MAIL  = 12

FOLDER_TYPE_USER_NOTE  = 17

FOLDER_TYPE_USER_TASK  = 15

FOLDER_TYPE_WASTEBASKET  = 4

FOLDERHIERARCHY_CHANGES  = 'FolderHierarchy:Changes'

FOLDERHIERARCHY_CONTENTCLASS  = 'FolderHierarchy:ContentClass'

FOLDERHIERARCHY_COUNT  = 'FolderHierarchy:Count'

FOLDERHIERARCHY_DISPLAYNAME  = 'FolderHierarchy:DisplayName'

FOLDERHIERARCHY_FOLDER  = 'FolderHierarchy:Folder'

FOLDERHIERARCHY_FOLDERS  = 'FolderHierarchy:Folders'

FOLDERHIERARCHY_FOLDERSYNC  = 'FolderHierarchy:FolderSync'

FOLDERHIERARCHY_PARENTID  = 'FolderHierarchy:ParentId'

FOLDERHIERARCHY_RESPONSE  = 'FolderHierarchy:Response'

FOLDERHIERARCHY_SERVERENTRYID  = 'FolderHierarchy:ServerEntryId'

FOLDERHIERARCHY_STATUS  = 'FolderHierarchy:Status'

FOLDERHIERARCHY_SYNCKEY  = 'FolderHierarchy:SyncKey'

FOLDERHIERARCHY_TYPE  = 'FolderHierarchy:Type'

FOLDERHIERARCHY_VERSION  = 'FolderHierarchy:Version'

GAL_ALIAS  = 'GAL:Alias'

GAL_COMPANY  = 'GAL:Company'

GAL_DATA  = 'GAL:Data'

GAL_DISPLAYNAME  = 'GAL:DisplayName'

GAL_EMAILADDRESS  = 'GAL:EmailAddress'

GAL_FIRSTNAME  = 'GAL:FirstName'

GAL_HOMEPHONE  = 'GAL:HomePhone'

GAL_LASTNAME  = 'GAL:LastName'

GAL_MOBILEPHONE  = 'GAL:MobilePhone'

GAL_OFFICE  = 'GAL:Office'

GAL_PHONE  = 'GAL:Phone'

GAL_PICTURE  = 'GAL:Picture'

GAL_STATUS  = 'GAL:Status'

GAL_TITLE  = 'GAL:Title'

IMAP_FLAG_FORWARD  = 'forward'

IMAP_FLAG_REPLY  = 'reply'

LIBRARY_VERSION  = '2.x.y-git'

MIME_SUPPORT_ALL  = 2

MIME_SUPPORT_NONE  = 0

MIME_SUPPORT_SMIME  = 1

POLICYTYPE_WBXML  = 'MS-EAS-Provisioning-WBXML'

POLICYTYPE_XML  = 'MS-WAP-Provisioning-XML'

PROVISION_DATA  = 'Provision:Data'

PROVISION_EASPROVISIONDOC  = 'Provision:EASProvisionDoc'

PROVISION_POLICIES  = 'Provision:Policies'

PROVISION_POLICY  = 'Provision:Policy'

PROVISION_POLICYKEY  = 'Provision:PolicyKey'

PROVISION_POLICYTYPE  = 'Provision:PolicyType'

PROVISION_PROVISION  = 'Provision:Provision'

PROVISION_REMOTEWIPE  = 'Provision:RemoteWipe'

PROVISION_STATUS  = 'Provision:Status'

PROVISIONING_FORCE  = \true

PROVISIONING_LOOSE  = 'loose'

PROVISIONING_NONE  = \false

REQUEST_TYPE_FOLDERSYNC  = 'foldersync'

REQUEST_TYPE_SYNC  = 'sync'

RESOLVE_RESULT_ADDRESSBOOK  = 2

RESOLVE_RESULT_GAL  = 1

RM_SUPPORT  = 'RightsManagement:RightsManagementSupport'

RM_TEMPLATEID  = 'RightsManagement:TemplateId'

RWSTATUS_NA  = 0

RWSTATUS_OK  = 1

RWSTATUS_PENDING  = 2

RWSTATUS_WIPED  = 3

SYNC_ADD  = 'Add'

SYNC_CLIENTENTRYID  = 'ClientEntryId'

SYNC_COMMANDS  = 'Commands'

SYNC_CONFLICT  = 'Conflict'

SYNC_CONVERSATIONMODE  = 'ConversationMode'

SYNC_DATA  = 'Data'

SYNC_DELETESASMOVES  = 'DeletesAsMoves'

SYNC_DOCUMENTLIBRARY_CONTENTLENGTH  = 'DocumentLibrary:ContentLength'

SYNC_DOCUMENTLIBRARY_CONTENTTYPE  = 'DocumentLibrary:ContentType'

SYNC_DOCUMENTLIBRARY_CREATIONDATE  = 'DocumentLibrary:CreationDate'

SYNC_DOCUMENTLIBRARY_DISPLAYNAME  = 'DocumentLibrary:DisplayName'

SYNC_DOCUMENTLIBRARY_ISFOLDER  = 'DocumentLibrary:IsFolder'

SYNC_DOCUMENTLIBRARY_ISHIDDEN  = 'DocumentLibrary:IsHidden'

SYNC_DOCUMENTLIBRARY_LASTMODIFIEDDATE  = 'DocumentLibrary:LastModifiedDate'

SYNC_DOCUMENTLIBRARY_LINKID  = 'DocumentLibrary:LinkId'

SYNC_FETCH  = 'Fetch'

SYNC_FILTERTYPE  = 'FilterType'

SYNC_FOLDER  = 'Folder'

SYNC_FOLDERID  = 'FolderId'

SYNC_FOLDERS  = 'Folders'

SYNC_FOLDERTYPE  = 'FolderType'

SYNC_GETCHANGES  = 'GetChanges'

SYNC_HEARTBEATINTERVAL  = 'HeartbeatInterval'

SYNC_LIMIT  = 'Limit'

SYNC_MAXITEMS  = 'MaxItems'

SYNC_MIMESUPPORT  = 'MIMESupport'

SYNC_MIMETRUNCATION  = 'MIMETruncation'

SYNC_MODIFY  = 'Modify'

SYNC_MOREAVAILABLE  = 'MoreAvailable'

SYNC_NEWMESSAGE  = 'NewMessage'

SYNC_NOTIFYGUID  = 'NotifyGUID'

SYNC_OPTIONS  = 'Options'

SYNC_PARTIAL  = 'Partial'

SYNC_REMOVE  = 'Remove'

SYNC_REPLIES  = 'Replies'

SYNC_RTFTRUNCATION  = 'RtfTruncation'

SYNC_SERVERENTRYID  = 'ServerEntryId'

SYNC_SOFTDELETE  = 'SoftDelete'

SYNC_STATUS  = 'Status'

SYNC_SUPPORTED  = 'Supported'

SYNC_SYNCHRONIZE  = 'Synchronize'

SYNC_SYNCKEY  = 'SyncKey'

SYNC_TRUNCATION  = 'Truncation'

SYNC_VERSION  = 'Version'

SYNC_WAIT  = 'Wait'

SYNC_WINDOWSIZE  = 'WindowSize'

TRUNCATION_1  = 1

TRUNCATION_2  = 2

TRUNCATION_3  = 3

TRUNCATION_4  = 4

TRUNCATION_5  = 5

TRUNCATION_6  = 6

TRUNCATION_7  = 7

TRUNCATION_8  = 8

TRUNCATION_9  = 9

TRUNCATION_ALL  = 0

TRUNCATION_NONE  = 9

VERSION_FOURTEEN  = '14.0'

VERSION_FOURTEENONE  = '14.1'

VERSION_SIXTEEN  = '16.0'

VERSION_TWELVE  = '12.0'

VERSION_TWELVEONE  = '12.1'

VERSION_TWOFIVE  = '2.5'

$certPath  : string

$decoder  : Horde_ActiveSync_Wbxml_Decoder

$device  : Horde_ActiveSync_Device

$driver  : Horde_ActiveSync_Driver_Base

$encoder  : Horde_ActiveSync_Wbxml_Encoder

$logger  : Horde_ActiveSync_Log_Logger

$multipart  : bool

$provisioning  : bool|string

$request  : Horde_Controller_Reqeust_Http

$state  : Horde_ActiveSync_State_Base

$_certPath  : string

Path to root certificate bundle

$_collectionsObj  : Horde_ActiveSync_Collections

The singleton collections handler.

$_compression  : bool

Support gzip compression of certain data parts?

$_decoder  : Horde_ActiveSync_Wbxml_Decoder

Wbxml decoder

$_device  : Horde_ActiveSync_Device

$_encoder  : Horde_ActiveSync_Wbxml_Encoder

Wbxml encoder

$_get  : array<string|int, mixed>

Local cache of Get variables/decoded base64 uri

$_globalError  : bool

Global error flag.

$_logger  : Horde_Log_Logger

The logger for this class.

$_loggerFactory  : Horde_ActiveSync_Interface_LoggerFactory

Logger

$_maxVersion  : float

Highest version to support.

$_multipart  : bool

Multipart support?

$_needMsRp  : bool

Flag to indicate we need to update the device version.

$_procid  : int

Process id (used in logging).

$_provisioning  : string

Provisioning support

$_supportedVersions  : array<string|int, mixed>

Supported EAS versions.

$_version  : float

The actual version we are supporting.

__construct()  : Horde_ActiveSync

Const'r

__get()  : mixed

Getter

_wrapLogger()  : mixed

activeSyncHeader()  : array<string|int, mixed>

Send the MS_Server-ActiveSync header.

authenticate()  : bool

Authenticate to the backend.

checkGlobalError()  : mixed

Return any global errors that occured during initial connection.

commandsHeader()  : string

Send protocol commands header.

contentTypeHeader()  : mixed

Send the content type header.

getCollectionsObject()  : Horde_ActiveSync_Collections

Return a collections singleton.

getGetVars()  : array<string|int, mixed>

Return the GET variables passed from the device, decoding from base64 if needed.

getImporter()  : Horde_ActiveSync_Connector_Importer

Return an Importer object.

getMIMETruncSize()  : int|bool

Return the number of bytes corresponding to the requested trunction constant. This applies to MIMETRUNCATION only.

getPolicyKey()  : int

Obtain the policy key header from the request.

getProtocolVersion()  : string

Obtain the ActiveSync protocol version requested by the client headers.

getSupportedCommands()  : string

Return the supported commands in a comma delimited string suitable for sending as the MS-ASProtocolCommands header.

getSupportedVersions()  : string

Return supported versions in a comma delimited string suitable for sending as the MS-ASProtocolVersions header.

getSyncCache()  : Horde_ActiveSync_SyncCache

Return a new, fully configured SyncCache.

getTruncSize()  : int|bool

Return the number of bytes corresponding to the requested trunction constant.

handleRequest()  : string|bool

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

messageFactory()  : Horde_ActiveSync_Message_Base

Factory method for creating Horde_ActiveSync_Message objects.

provisionHeader()  : mixed

Send provision header

provisioningRequired()  : mixed

Send the headers indicating that provisioning is required.

setLogger()  : mixed

Setter for the logger factory.

setProvisioning()  : mixed

Setter for provisioning support

setRootCertificatePath()  : mixed

Set the local path to the root certificate bundle.

setSupportedVersion()  : mixed

Allow to force the highest version to support.

versionHeader()  : string

Send the protocol versions header.

_handleDevice()  : bool

Handle device checks. Takes into account permissions and restrictions via various callback methods.

_handleOptionsRequest()  : mixed

Send the OPTIONS request response headers.

_setLogger()  : mixed

Instantiate the logger from the factory and inject into all needed objects.