API Documentation
\

\Horde_ActiveSync_Request_ItemOperations

ActiveSync Handler for ItemOperations requests

Summary

Methods
Properties
Constants
__construct()
checkPolicyKey()
setLogger()
handle()
No public properties found
ITEMOPERATIONS_ITEMOPERATIONS
ITEMOPERATIONS_FETCH
ITEMOPERATIONS_STORE
ITEMOPERATIONS_OPTIONS
ITEMOPERATIONS_RANGE
ITEMOPERATIONS_TOTAL
ITEMOPERATIONS_PROPERTIES
ITEMOPERATIONS_DATA
ITEMOPERATIONS_STATUS
ITEMOPERATIONS_RESPONSE
ITEMOPERATIONS_VERSION
ITEMOPERATIONS_SCHEMA
ITEMOPERATIONS_PART
ITEMOPERATIONS_EMPTYFOLDERCONTENT
ITEMOPERATIONS_DELETESUBFOLDERS
ITEMOPERATIONS_USERNAME
ITEMOPERATIONS_PASSWORD
ITEMOPERATIONS_MOVE
ITEMOPERATIONS_DSTFLDID
ITEMOPERATIONS_CONVERSATIONID
ITEMOPERATIONS_MOVEALWAYS
STATUS_SUCCESS
STATUS_PROTERR
STATUS_SERVERERR
STATUS_ATTINVALID
STATUS_POLICYERR
STATUS_PARTSUCCESS
STATUS_CREDENTIALS
STATUS_PROTERR_OPTIONS
STATUS_NOT_SUPPORTED
_bodyPartPrefs()
_bodyPrefs()
_rightsManagement()
_mimeSupport()
_cleanUpAfterPairing()
_requireProvisionWbxml()
_handle()
_outputStatus()
_getDataSize()
_handleError()
$_driver
$_state
$_encoder
$_decoder
$_request
$_provisioning
$_statusCode
$_activeSync
$_logger
$_device
$_procid
N/A
No private methods found
No private properties found
N/A

Constants

ITEMOPERATIONS_ITEMOPERATIONS

ITEMOPERATIONS_ITEMOPERATIONS

ITEMOPERATIONS_FETCH

ITEMOPERATIONS_FETCH

ITEMOPERATIONS_STORE

ITEMOPERATIONS_STORE

ITEMOPERATIONS_OPTIONS

ITEMOPERATIONS_OPTIONS

ITEMOPERATIONS_RANGE

ITEMOPERATIONS_RANGE

ITEMOPERATIONS_TOTAL

ITEMOPERATIONS_TOTAL

ITEMOPERATIONS_PROPERTIES

ITEMOPERATIONS_PROPERTIES

ITEMOPERATIONS_DATA

ITEMOPERATIONS_DATA

ITEMOPERATIONS_STATUS

ITEMOPERATIONS_STATUS

ITEMOPERATIONS_RESPONSE

ITEMOPERATIONS_RESPONSE

ITEMOPERATIONS_VERSION

ITEMOPERATIONS_VERSION

ITEMOPERATIONS_SCHEMA

ITEMOPERATIONS_SCHEMA

ITEMOPERATIONS_PART

ITEMOPERATIONS_PART

ITEMOPERATIONS_EMPTYFOLDERCONTENT

ITEMOPERATIONS_EMPTYFOLDERCONTENT

ITEMOPERATIONS_DELETESUBFOLDERS

ITEMOPERATIONS_DELETESUBFOLDERS

ITEMOPERATIONS_USERNAME

ITEMOPERATIONS_USERNAME

ITEMOPERATIONS_PASSWORD

ITEMOPERATIONS_PASSWORD

ITEMOPERATIONS_MOVE

ITEMOPERATIONS_MOVE

ITEMOPERATIONS_DSTFLDID

ITEMOPERATIONS_DSTFLDID

ITEMOPERATIONS_CONVERSATIONID

ITEMOPERATIONS_CONVERSATIONID

ITEMOPERATIONS_MOVEALWAYS

ITEMOPERATIONS_MOVEALWAYS

STATUS_SUCCESS

STATUS_SUCCESS

STATUS_PROTERR

STATUS_PROTERR

STATUS_SERVERERR

STATUS_SERVERERR

STATUS_ATTINVALID

STATUS_ATTINVALID

STATUS_POLICYERR

STATUS_POLICYERR

STATUS_PARTSUCCESS

STATUS_PARTSUCCESS

STATUS_CREDENTIALS

STATUS_CREDENTIALS

STATUS_PROTERR_OPTIONS

STATUS_PROTERR_OPTIONS

STATUS_NOT_SUPPORTED

STATUS_NOT_SUPPORTED

Properties

$_request

$_request : \Horde_Controller_Request_Http

Request object

Type

\Horde_Controller_Request_Http

$_provisioning

$_provisioning : integer

Whether we require provisioned devices.

Valid values are:

  • Horde_ActiveSync::PROVISIONING_FORCE: Accept ONLY provisioned devices
  • Horde_ActiveSync::PROVISIONING_LOOSE: Force provisioning if device supports provisioning, allow non-provisionable devices as well.
  • Horde_ActiveSync::PROVISIONING_NONE: Allow any device.

Type

integer

$_statusCode

$_statusCode : integer

Used to track what error code to send back to client on failure

Type

integer

$_activeSync

$_activeSync : \Horde_ActiveSync

ActiveSync server

Type

\Horde_ActiveSync

$_logger

$_logger : \Horde_Log_Logger

Logger

Type

\Horde_Log_Logger

$_procid

$_procid : integer

The procid

Type

integer

Methods

checkPolicyKey()

checkPolicyKey(string  $sentKey, string  $requestType = null) : boolean

Ensure the client's policy key is current.

Parameters

string $sentKey

The policykey sent to us by the client
string $requestType

The type of request we are handling. A Horde_ActiveSync constant.

Returns

boolean

setLogger()

setLogger(\Horde_Log_Logger  $logger)

Set the logger.

Parameters

\Horde_Log_Logger $logger

handle()

handle() : boolean

Handle the request.

Returns

boolean

_bodyPartPrefs()

_bodyPartPrefs(array  $options)

Parse incoming BODYPARTPREFERENCE options.

Parameters

array $options

An array structure to parse the data into.

_bodyPrefs()

_bodyPrefs(  $options)

Parse incoming BODYPREFERENCE options.

Parameters

$options

_rightsManagement()

_rightsManagement(  $collection)

Parameters

$collection

_mimeSupport()

_mimeSupport(  $collection)

Parameters

$collection

_cleanUpAfterPairing()

_cleanUpAfterPairing()

Clean up after initial pairing. Initial pairing can happen either as a result of either a FOLDERSYNC or PROVISION command, depending on the device capabilities.

_requireProvisionWbxml()

_requireProvisionWbxml(string  $requestType, integer  $status)

Send WBXML to indicate provisioning is required.

Parameters

string $requestType

The type of request we are handling.
integer $status

The reason we need to provision.

_handle()

_handle() : string

Handle the request.

Returns

string —

The Content-Type of the attachment data.

_outputStatus()

_outputStatus()

Helper to send the status output.

_getDataSize()

_getDataSize(  $data) : integer

Return the size of the specified data.

Parameters

$data

Returns

integer —

The size of the data.

_handleError()

_handleError(array  $data,   $error)

Parameters

array $data
$error