Overview

Packages

  • Auth
  • Core
  • Horde
    • Imsp
  • None
  • Notification

Classes

  • Horde
  • Horde_Config
  • Horde_Config_Form
  • Horde_Core_ActiveSync_Connector
  • Horde_Core_ActiveSync_Driver
  • Horde_Core_Ajax_Application
  • Horde_Core_Ajax_Imple
  • Horde_Core_Ajax_Imple_AutoCompleter
  • Horde_Core_Ajax_Imple_Geocoder_Geonames
  • Horde_Core_Ajax_Imple_SpellChecker
  • Horde_Core_Alarm_Handler_Notify
  • Horde_Core_Auth_Application
  • Horde_Core_Auth_Composite
  • Horde_Core_Auth_Ldap
  • Horde_Core_Auth_Msad
  • Horde_Core_Auth_Shibboleth
  • Horde_Core_Auth_Signup_Base
  • Horde_Core_Auth_Signup_Form
  • Horde_Core_Auth_Signup_Null
  • Horde_Core_Auth_Signup_Sql
  • Horde_Core_Auth_Signup_SqlObject
  • Horde_Core_Autoloader_Callback_Mime
  • Horde_Core_Autoloader_Callback_Nls
  • Horde_Core_Block
  • Horde_Core_Block_Collection
  • Horde_Core_Block_Layout
  • Horde_Core_Block_Layout_Manager
  • Horde_Core_Block_Layout_View
  • Horde_Core_Block_Upgrade
  • Horde_Core_Browser
  • Horde_Core_Bundle
  • Horde_Core_Cli
  • Horde_Core_Controller_NotFound
  • Horde_Core_Controller_RequestConfiguration
  • Horde_Core_Controller_RequestMapper
  • Horde_Core_Controller_SettingsFinder
  • Horde_Core_Db_Migration
  • Horde_Core_Factory_ActiveSyncBackend
  • Horde_Core_Factory_ActiveSyncServer
  • Horde_Core_Factory_ActiveSyncState
  • Horde_Core_Factory_Ajax
  • Horde_Core_Factory_Alarm
  • Horde_Core_Factory_Auth
  • Horde_Core_Factory_AuthSignup
  • Horde_Core_Factory_Base
  • Horde_Core_Factory_BlockCollection
  • Horde_Core_Factory_Browser
  • Horde_Core_Factory_Cache
  • Horde_Core_Factory_Crypt
  • Horde_Core_Factory_Data
  • Horde_Core_Factory_Db
  • Horde_Core_Factory_DbBase
  • Horde_Core_Factory_DbPear
  • Horde_Core_Factory_Dns
  • Horde_Core_Factory_Editor
  • Horde_Core_Factory_Facebook
  • Horde_Core_Factory_Group
  • Horde_Core_Factory_History
  • Horde_Core_Factory_HttpClient
  • Horde_Core_Factory_Identity
  • Horde_Core_Factory_Image
  • Horde_Core_Factory_Imple
  • Horde_Core_Factory_Imsp
  • Horde_Core_Factory_ImspAuth
  • Horde_Core_Factory_Injector
  • Horde_Core_Factory_KolabServer
  • Horde_Core_Factory_KolabSession
  • Horde_Core_Factory_KolabStorage
  • Horde_Core_Factory_Ldap
  • Horde_Core_Factory_Lock
  • Horde_Core_Factory_Logger
  • Horde_Core_Factory_LoginTasks
  • Horde_Core_Factory_Mail
  • Horde_Core_Factory_Mapper
  • Horde_Core_Factory_Matcher
  • Horde_Core_Factory_Memcache
  • Horde_Core_Factory_MimeViewer
  • Horde_Core_Factory_Notification
  • Horde_Core_Factory_Perms
  • Horde_Core_Factory_PermsCore
  • Horde_Core_Factory_Prefs
  • Horde_Core_Factory_Request
  • Horde_Core_Factory_Secret
  • Horde_Core_Factory_SessionHandler
  • Horde_Core_Factory_Share
  • Horde_Core_Factory_ShareBase
  • Horde_Core_Factory_Template
  • Horde_Core_Factory_TextFilter
  • Horde_Core_Factory_ThemesCache
  • Horde_Core_Factory_Token
  • Horde_Core_Factory_Tree
  • Horde_Core_Factory_Twitter
  • Horde_Core_Factory_UrlShortener
  • Horde_Core_Factory_Vfs
  • Horde_Core_Factory_View
  • Horde_Core_Factory_Weather
  • Horde_Core_Group_Ldap
  • Horde_Core_Log_Logger
  • Horde_Core_LoginTasks
  • Horde_Core_LoginTasks_Backend_Horde
  • Horde_Core_LoginTasks_SystemTask_Upgrade
  • Horde_Core_Mime_Viewer_Syntaxhighlighter
  • Horde_Core_Mime_Viewer_Vcard
  • Horde_Core_Notification_Event_Status
  • Horde_Core_Notification_Handler_Decorator_Hordelog
  • Horde_Core_Notification_Storage_Session
  • Horde_Core_Perms
  • Horde_Core_Perms_Ui
  • Horde_Core_Prefs_Cache_Session
  • Horde_Core_Prefs_Identity
  • Horde_Core_Prefs_Storage_Configuration
  • Horde_Core_Prefs_Storage_Hooks
  • Horde_Core_Prefs_Storage_Upgrade
  • Horde_Core_Prefs_Ui
  • Horde_Core_Prefs_Ui_Widgets
  • Horde_Core_Share_Driver
  • Horde_Core_Share_FactoryCallback
  • Horde_Core_Sidebar
  • Horde_Core_Text_Filter_Bbcode
  • Horde_Core_Text_Filter_Emails
  • Horde_Core_Text_Filter_Emoticons
  • Horde_Core_Text_Filter_Highlightquotes
  • Horde_Core_Translation
  • Horde_Core_Tree_Html
  • Horde_Core_Tree_Javascript
  • Horde_Core_Tree_Simplehtml
  • Horde_Core_Ui_FlagImage
  • Horde_Core_Ui_JsCalendar
  • Horde_Core_Ui_Language
  • Horde_Core_Ui_Layout
  • Horde_Core_Ui_ModalFormRenderer
  • Horde_Core_Ui_Pager
  • Horde_Core_Ui_Tabs
  • Horde_Core_Ui_TagCloud
  • Horde_Core_Ui_VarRenderer
  • Horde_Core_Ui_VarRenderer_Html
  • Horde_Core_Ui_VarRenderer_TablesetHtml
  • Horde_Core_Ui_Widget
  • Horde_ErrorHandler
  • Horde_Help
  • Horde_Menu
  • Horde_Registry
  • Horde_Registry_Api
  • Horde_Registry_Application
  • Horde_Registry_Caller
  • Horde_Registry_Nlsconfig
  • Horde_Script_Files
  • Horde_Session
  • Horde_Session_Null
  • Horde_Themes
  • Horde_Themes_Cache
  • Horde_Themes_Css
  • Horde_Themes_Element
  • Horde_Themes_Image
  • Horde_Themes_Sound

Exceptions

  • Horde_Exception_HookNotSet
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Core_ActiveSync_Driver

Horde backend. Provides the communication between horde data and ActiveSync server.

Copyright 2010-2012 Horde LLC (http://www.horde.org/)

Horde_ActiveSync_Driver_Base
Extended by Horde_Core_ActiveSync_Driver
Package: Core
Author: Michael J. Rubinsky mrubinsk@horde.org
Located at Horde/Core/ActiveSync/Driver.php
Methods summary
public Horde_ActiveSync_Driver_Horde
# __construct( array $params = array() )

Const'r

Required params (in addition to the base class' requirements):
  connector => Horde_ActiveSync_Driver_Horde_Connector_Registry object
  auth      => Horde_Auth object

Const'r

Required params (in addition to the base class' requirements):
  connector => Horde_ActiveSync_Driver_Horde_Connector_Registry object
  auth      => Horde_Auth object

Parameters

$params
Configuration parameters.

Returns

Horde_ActiveSync_Driver_Horde
public
# logon( mixed $username, mixed $password, mixed $domain = null )

Authenticate to Horde

Authenticate to Horde

See

framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#Logon($username , $domain , $password)
public
# logOff( )

Clean up

Clean up

See

framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#Logoff()
public boolean
# setup( string $user )

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.

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.

Parameters

$user
The username to sync as on the backend.

Returns

boolean
public
# getWasteBasket( )

Get the wastebasket folder

Get the wastebasket folder

See

framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#getWasteBasket()
public array
# getFolderList( )

Return a list of available folders

Return a list of available folders

Returns

array
An array of folder stats
public Horde_ActiveSync_Message_Folder
# getFolder( string $id )

Retrieve folder

Retrieve folder

Parameters

$id
The folder id

Returns

Horde_ActiveSync_Message_Folder
public a
# statFolder( mixed $id )

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.

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.

Parameters

$id

Returns

a
stat hash
public
# getMessageList( mixed $folderid, mixed $cutoffdate )

Get the message list of specified folder

Get the message list of specified folder

See

framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#getMessageList($folderId , $cutOffDate)
public array
# getServerChanges( string $folderId, integer $from_ts, integer $to_ts, integer $cutoffdate )

Get a list of server changes that occured during the specified time period.

Get a list of server changes that occured during the specified time period.

Parameters

$folderId
The server id of the collection to check.
$from_ts
The starting timestamp
$to_ts
The ending timestamp
$cutoffdate
The earliest date to retrieve back to

Returns

array

A list of messge uids that have chnaged in the specified time period.

public
# getMessage( mixed $folderid, mixed $id, mixed $truncsize, mixed $mimesupport = 0 )

Get a message from the backend

Get a message from the backend

See

framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#getMessage
public
# statMessage( mixed $folderid, mixed $id )

Get message stat data

Get message stat data

See

framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#statMessage($folderId , $id)
public
# deleteMessage( mixed $folderid, mixed $id )

Delete a message

Delete a message

See

framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#deleteMessage($folderid , $id)
public
# changeMessage( string $folderid, string $id, Horde_ActiveSync_Message_Base $message, object $device )

Add/Edit a message

Add/Edit a message

Parameters

$folderid
<p>The server id for the folder the message belongs to.</p>
$id
<p>The server's uid for the message if this is a change to an existing message.</p>
$message
The activesync message
$device
The device information

See

framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#changeMessage($folderid , $id , $message)
public array
# getSearchResults( string $query, string $range )

Returns array of items which contain contact information

Returns array of items which contain contact information

Parameters

$query
<p>The text string to match against any textual ANR (Automatic Name Resolution) properties. Exchange's searchable ANR properties are currently: firstname, lastname, alias, displayname, email</p>
$range
The range to return (for example, 1-50).

Returns

array
with 'rows' and 'range' keys
public boolean
# sendMail( string $rfc822, boolean $forward = false, boolean $reply = false, boolean $parent = false )

Sends the email represented by the rfc822 string received by the PIM. Currently only used when meeting requests are sent from the PIM.

Sends the email represented by the rfc822 string received by the PIM. Currently only used when meeting requests are sent from the PIM.

Parameters

$rfc822
The rfc822 mime message
$forward
Indicates if this is a forwarded message
$reply
Indicates if this is a reply
$parent
Parent message in thread.

Returns

boolean
Constants summary
string APPOINTMENTS_FOLDER

Constants *

Constants *

# 'Calendar'
string CONTACTS_FOLDER
# 'Contacts'
string TASKS_FOLDER
# 'Tasks'
string FOLDER_INBOX
# 'Inbox'
API documentation generated by ApiGen