• Home
• Horde_ActiveSync_Driver_Base

PHP Class Horde_ActiveSync_Driver_Base, horde

Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_authPass	string	User password
$_authUser	string	Authenticating user
$_device	Horde_ActiveSync_Device	The device object
$_logger	Horde_Log_Logger	Logger instance
$_params	array	Parameters
$_state	Horde_ActiveSync_State_Base	The state driver for this request. Needs to be injected into this class.
$_tempMap	array	Temporary serverid to uid map. Used when creating the hierarchy for the first time
$_typeMap
$_user	string	The username to sync with the backend as
$_version	float	Protocol version

Public Methods

Method	Description
__construct ( array $params = [] ) : Horde_ActiveSync_Driver	Const'r
__destruct ( )	Prevent circular dependency issues.
addDefaultBodyPrefTruncation ( array $bodyprefs ) : array	Add default truncation values for this driver.
authenticate ( string $username, string $password, string $domain = null ) : mixed	Any code needed to authenticate to backend as the actual user.
autoDiscover ( ) : array	Return properties for an AUTODISCOVER request.
buildFbString ( stdClass $fb, Horde_Date $start, Horde_Date $end ) : string	Build a EAS style FB string. Essentially, each digit represents 1/2 hour.
changeFolder ( string $id, string $displayname, string $parent, string $uid = null ) : Horde_ActiveSync_Message_Folder	Change a folder on the server.
changeMessage ( string $folderid, string $id, Horde_ActiveSync_Message_Base $message, Horde_ActiveSync_Device $device ) : array | boolean	Add/Edit a message
clearAuthentication ( ) : boolean	Clear authentication
deleteFolder ( string $id, string $parent = Horde_ActiveSync::FOLDER_ROOT )	Delete a folder on the server.
deleteMessage ( string $folderid, array $ids )	Delete a message
fetch ( string $folderid, string $id, array $collection ) : Horde_ActiveSync_Message_Base	Obtain the FULL message from the backend, regardless of any truncation options.
getAttachment ( string $name, array $options = [] ) : array	Return the specified attachment.
getCurrentPolicy ( ) : array	Return the security policies.
getFolder ( string $id ) : Horde_ActiveSync_Message_Folder	Return the ActiveSync message object for the specified folder.
getFolderList ( ) : array	Get the list of folder stat arrays @see self::statFolder()
getFolders ( ) : array	Return an array of folder objects.
getFreebusy ( string $user, array $options = [] ) : mixed	Request freebusy information from the server
getHeartbeatConfig ( ) : array	Obtain the ping heartbeat settings
getMessage ( string $folderid, string $id, array $collection ) : Horde_ActiveSync_Message_Base	Obtain an ActiveSync message from the backend.
getProvisioning ( ) : mixed	Returns the provisioning support for the current request.
getSearchResults ( string $type, array $query ) : array	Returns array of items which contain contact information
getServerChanges ( string $folderId, integer $from_ts, integer $to_ts, integer $cutoffdate, boolean $ping ) : array	Get a list of server changes that occured during the specified time period.
getSettings ( array $settings, Horde_ActiveSync_Device $device ) : array	Return settings from the backend for a SETTINGS request.
getSpecialFolderNameByType ( string $type ) : string	Return the server id of the specified special folder type.
getSyncStamp ( $collection ) : integer	Return the SyncStamp - the value used to determine the end of the current sync range. Default implementation uses timestamps. Concrete drivers can override this to provide another method to do this, such as using modification sequences.
getUser ( ) : string	Get the username for this request.
getUsernameFromEmail ( string $email ) : string	Attempt to guess a username based on the email address passed from EAS Autodiscover requests.
getWasteBasket ( string $class ) : string | boolean	Get the wastebasket folder.
itemOperationsFetchMailbox ( string $longid, array $bodyprefs, boolean $mimesupport ) : Horde_ActiveSync_Message_Base	Returnmail object represented by the specified longid. Used to fetch email objects from a search result, which only returns a 'longid'.
itemOperationsGetAttachmentData ( string $filereference )	Return the specified attachement data for an ITEMOPERATIONS request.
itemOperationsGetDocumentLibraryLink ( string $linkid, array $cred ) : array	Return a documentlibrary item.
meetingResponse ( array $response ) : string	Hanlde meeting responses.
moveMessage ( string $folderid, array $ids, string $newfolderid ) : array	Move message
resolveRecipient ( string $type, string $search, array $options = [] ) : array	Handle ResolveRecipient requests
sendMail ( mixed $rfc822, integer $forward = null, integer $reply = null, string $parent = null, boolean $save = true ) : boolean	Sends the email represented by the rfc822 string received by the client.
setDevice ( Horde_ActiveSync_Device $device )	Set the currently connected device
setLogger ( Horde_Log_Logger $logger )	Setter for the logger instance
setProtocolVersion ( float $version )	Set the protocol version. Can't do it in constructer since we don't know the version at the time this driver is instantiated.
setReadFlag ( string $folderid, integer $uid, integer $flag )	Set the read (\seen) flag on the specified message.
setSettings ( array $settings, Horde_ActiveSync_Device $device ) : array	Set backend settings from a SETTINGS request.
setup ( string $user ) : boolean	Setup sync parameters. The user provided here is the user the backend will sync with. This allows you to authenticate as one user, and sync as another, if the backend supports this.
statFolder ( string $id, mixed $parent, mixed $mod = null ) : a	Stat folder. Note that since the only thing that can ever change for a folder is the name, we use that as the 'mod' value.
statMailMessage ( string $folderid, integer | array $id ) : array	Build a stat structure for an email message.
statMessage ( string $folderId, string $id ) : hash	Get a message stat.

Protected Methods

Method	Description
_getClassFromType ( integer $type ) : string	Convert a TYPE constant into it's associated CLASS constant.
_getFolderUidForBackendId ( string $id, string $type = null, string $old_id = null ) : string	Get an activesync uid for the given backend serverid. If we've seen this serverid before, return the previously created uid, otherwise return a new one.

Method Details

Property Details