• Home
• Horde_Core_ActiveSync_Driver

PHP Class Horde_Core_ActiveSync_Driver, horde

Copyright 2010-2014 Horde LLC (http://www.horde.org/) Datei anzeigen Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_auth	Horde_Core_ActiveSync_Auth	Authentication object
$_classMap	array	Class => Id map
$_connector	Horde_Core_ActiveSync_Connector	Horde connector instance
$_displayMap	array	Mappings for server uids -> display names. Populated in the const'r so we can use localized text.
$_folders	array	Local cache of folders polled from the various backends.
$_imap	Horde_ActiveSync_Imap_Adapter	Imap client adapter
$_modCache		Cache message stats
$_pid	integer	Current process id
$_verbs	array	Local cache of last verb searches.

Public Methods

Method	Description
__construct ( array $params = [] )	Const'r
authenticate ( string $username, string $password, string $domain = null ) : mixed	Authenticate to Horde
autoDiscover ( array $params = [] ) : array	Attempt to autodiscover. Autodiscovery happens before the user is authenticated, and ALWAYS uses the user's email address. We have to do our best to translate email address to username. If this fails, the device simply falls back to requiring full user configuration.
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 $old_name, string $new_name, string $parent, string $uid = null, integer $type = 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 ( )	Clean up
createDeviceCallback ( Horde_ActiveSync_Device $device ) : boolean | integer	Callback method called before new device is created for a user. Allows final check of permissions.
deleteFolder ( string $id, string $parent = Horde_ActiveSync::FOLDER_ROOT )	Delete a folder on the server.
deleteMessage ( string $folderid, array $ids, boolean $instanceids = false ) : array	Delete a message
deviceCallback ( Horde_ActiveSync_Device $device ) : boolean | integer	Callback that allows custom policy checking on the device before allowing it to connect. Useful for things like limiting the types of devices that can connect e.g., not allowing iOS devices etc.
getAttachment ( string $name, array $options = [] ) : array	Return the specified attachment.
getCurrentPolicy ( boolean | array $device = false ) : array	Return the security policies.
getFolder ( string $id ) : Horde_ActiveSync_Message_Folder	Return a Horde_ActiveSync_Message_Folder object.
getFolderList ( ) : array	Return an array of stats for the server's folder list.
getFolders ( ) : array	Return an array of the server's folder objects.
getFreebusy ( $user, array $options = [] )	Request freebusy information from the server
getMessage ( string $folderid, string $id, array $collection ) : Horde_ActiveSync_Message_Base	Obtain an ActiveSync message from the backend.
getProvisioning ( Horde_ActiveSync_Device $device = null ) : mixed	Returns the provisioning support for the current request.
getSearchResults ( string $type, array $query ) : array	Returns array of items which contain contact information
getServerChanges ( Horde_ActiveSync_Folder_Base $folder, integer $from_ts, integer $to_ts, integer $cutoffdate, boolean $ping, boolean $ignoreFirstSync = false, integer $maxitems = 100, boolean $refreshFilter = false ) : array	Get a list of server changes that occured during the specified time period.
getSettings ( array $settings, stdClass $device ) : array	Return settings from the backend for a SETTINGS request.
getSpecialFolderNameByType ( string $type ) : string | boolean	Return the server id of the specified special folder type.
getSyncStamp ( string $collection, integer $last = null ) : integer | boolean	Return the SyncStamp - the value used to determine the end of the current sync range. If the collection backend supports modification sequences, we will use that, otherwise return the current timestamp.
getUsernameFromEmail ( string $email ) : string	Attempt to guess a username based on the email address passed from EAS Autodiscover requests.
getWasteBasket ( $class ) : string | boolean	Get the wastebasket folder. If this returns false, imap deletions are permanent. If it returns a valid mailbox, deletions are treated as moves to this mailbox. Note that any collection class other than Horde_ActiveSync::CLASS_EMAIL will return false.
itemOperationsEmptyFolder ( array $params )	Empty specified mailbox.
itemOperationsFetchMailbox ( string $longid, array $bodyprefs, integer $mimesupport ) : Horde_ActiveSync_Message_Base	Return Horde_Imap_Message_Mail object represented by the specified longid. Used to fetch email objects from a search result, which only returns a 'longid'.
itemOperationsGetAttachmentData ( string $filereference ) : Horde_ActiveSync_Message_AirSyncBaseFileAttachment	Return the specified attachement data for an ITEMOPERATIONS request.
itemOperationsGetDocumentLibraryLink ( string $linkid, array $cred ) : array	Return a documentlibrary item.
meetingResponse ( array $response ) : string	Handle meeting responses.
modifyDeviceCallback ( Horde_ActiveSync_Device $device ) : Horde_ActiveSync_Device	Allow modification of device properties before request processing continues.
moveMessage ( string $folderid, array $ids, string $newfolderid ) : array	Move message
resolveRecipient ( string $type, string $search, array $opts = [] ) : array	Handle ResolveRecipient requests
sendMail ( mixed $rfc822, integer | boolean $forward = false, integer | boolean $reply = false, string $parent = false, boolean $save = true, Horde_ActiveSync_Message_SendMail $message = null ) : boolean	Sends the email represented by the rfc822 string received by the PIM.
setLogger ( Horde_Log_Logger $logger )	Set the logger.
setReadFlag ( string $folderId, string $id, integer $flags )	Set the read (\seen) flag on the specified message.
setSettings ( array $settings, stdClass $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 (Horde does not).
statFolder ( string $id, mixed $parent = '0', mixed $mod = null, string $serverid = null, integer $type = 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 ( $folderid, $id )	Get message stat data

Protected Methods

Method	Description
_buildDummyFolder ( $id )
_buildNonMailFolder ( string $id, stirng $parent, integer $type, string $name ) : Horde_ActiveSync_Message_Folder	Helper to build a folder object for non-email folders.
_endBuffer ( )	End output buffering, log any unexpected output.
_getFolder ( string $id, array $params = [] ) : Horde_ActiveSync_Message_Folder	Factory for creating new Horde_ActiveSync_Message_Folder objects from within this class.
_getIdentityFromAddress ( ) : string	Return the current user's From/Reply_To address.
_getLastVerb ( string $mid ) : array	Return the last verb executed for the specified Message-ID.
_getMailFolder ( string $sid, array $fl, array $f ) : Horde_ActiveSync_Message_Folder	Return a folder object representing an email folder. Attempt to detect special folders appropriately.
_getMailFolders ( ) : array	Return the list of mail server folders.
_getMaillogChanges ( Horde_ActiveSync_Folder_Imap $folder, integer $ts ) : Horde_ActiveSync_Folder_Imap	Get verb changes from the maillog.
_getPolicyFromPerms ( boolean $deviceinfo = false ) : array	Return a policy array suitable for transforming into either wbxml or xml to send to the device in the provision response.
_getPolicyValue ( $policy, $allowed )
_mungeCert ( string $cert ) : string	Removes the beginning/ending delimiters from the certificate.
_parseFolderId ( string $id, boolean $checkEmail = false ) : string | array	Parse a folderid.
_searchGal ( array $query ) : array	Perform a search of the Global Address Book.
_searchMailbox ( array $query ) : array	Perform a search of the email store.
_smartStatMessage ( string $folderid, string $id, boolean $hint ) : message	Stat a backend item, optionally using the cached value if available.

Method Details

Property Details