$_registry
$_registry : \Horde_Registry
Horde registry
Registry connector for Horde backend.
Provides the communication between the Horde Registry on the local machine and the ActiveSync Horde driver.
$_registry : \Horde_Registry
Horde registry
__construct(array $params = array()) : \Horde_ActiveSync_Driver_Horde_Connector_Registry
Const'r
array | $params | Configuration parameters. Requires:
|
calendar_listUids(integer $startstamp, integer $endstamp, string $calendar) : array
Get a list of events from horde's calendar api
integer | $startstamp | The start of time period. |
integer | $endstamp | The end of time period |
string | $calendar | The calendar id. If null, uses multiplexed. @since 2.12.0 |
calendar_export(string $uid, array $options = array(), string $calendar = null) : \Horde_ActiveSync_Message_Appointment
Export the specified event as an ActiveSync message
string | $uid | The calendar id. |
array | $options | Options to pass to the backend exporter.
|
string | $calendar | The calendar id. If null, uses multiplexed. @since 2.12.0 |
The requested event.
calendar_import(\Horde_ActiveSync_Message_Appointment $content, string $calendar = null) : string
Import an event into the user's default calendar.
\Horde_ActiveSync_Message_Appointment | $content | The event content |
string | $calendar | The calendar id. @since 2.12.0 |
The event's UID.
calendar_import16(\Horde_ActiveSync_Message_Appointment $content, string $calendar = null) : array
Version of calendar_import capable of returning an array of values.
Needed for EAS 16 support in order to deal with the fact that attachment actions are handled within the Message object.
\Horde_ActiveSync_Message_Appointment | $content | The event content |
string | $calendar | The calendar id. |
calendar_import_attendee(\Horde_Icalendar_vEvent $vEvent, string $attendee)
Import an event response into a user's calendar. Used for updating attendee information from a meeting response.
\Horde_Icalendar_vEvent | $vEvent | The event data. |
string | $attendee | The attendee. |
calendar_replace(string $uid, \Horde_ActiveSync_Message_Appointment $content, string $calendar = null) : null|array
Replace the event with new data
string | $uid | The UID of the event to replace. |
\Horde_ActiveSync_Message_Appointment | $content | The new event. |
string | $calendar | The calendar id. @since 2.12.0 |
May return an array of 'uid' and 'atchash' or null.
calendar_delete(string $uid, string $calendar = null, string $instanceid = null)
Delete an event from Horde's calendar storage
string | $uid | The UID of the event to delete |
string | $calendar | The calendar id. @since 2.12.0 @deprecated (Not used). |
string | $instanceid | The instanceid if this is a EAS 16.0 instance. @since 2.23.0 |
calendar_getActionTimestamp(string $uid, string $action, string $calendar = null) : integer
Return the timestamp for the last time $action was performed.
string | $uid | The UID of the event we are interested in. |
string | $action | The action we are interested in (add, modify...). |
string | $calendar | The calendar id, if not using multiplexed data. |
calendar_move(string $uid, string $source, string $target) : string|boolean
Move a calendar event.
string | $uid | The event UID. |
string | $source | The source calendar's id. |
string | $target | The target calendar's id. |
The UID if successfully moved otherwise false.
contacts_export(string $uid, array $options = array()) : \Horde_ActiveSync_Message_Contact
Export the specified contact from Horde's contacts storage
string | $uid | The contact's UID |
array | $options | Exporter options:
|
The contact object.
contacts_import(\Horde_ActiveSync_Message_Contact $content, string $addressbook = null) : mixed
Import the provided contact data into Horde's contacts storage
\Horde_ActiveSync_Message_Contact | $content | The contact data |
string | $addressbook | The addessbook id. @since 2.12.0 |
string|boolean The new UID or false on failure.
contacts_getActionTimestamp(string $uid, string $action, string $addressbook = null) : integer
Get the timestamp of the most recent occurance of $action for the specifed contact
string | $uid | The UID of the contact to search. |
string | $action | The action to lookup. |
string | $addressbook | The addressbook id, if not using multiplex. |
contacts_search(string $query, array $options = array()) : array
Search the contacts store.
string | $query | The search string. |
array | $options | Additional options:
|
The search results.
resolveRecipient(string $query, array $opts = array()) : array
Resolve a recipient
string | $query | The search string. Ususally an email address. |
array | $opts | Any additional options:
|
The search results, keyed by the $query.
files_browse(string $path) : array
Browse VFS backend.
string | $path | The path to browse/fetch. This should be in UNC format with the "server" portion specifying backend name. e.g., \file\mike\file.txt or \sql\mike\file.txt |
An array of data arrays with the following structure: linkid: (string) The UNC path for this resource. name: (string) The display name of the resource. content-length: (integer) The byte size of the resource (if a file). modified: (Horde_Date) The modification time of the resource, if available. create: (Horde_Date) The creation time of the resource, if available. is_folder: (boolean) True if the resource is a folder. data: (Horde_Stream) The data, if resource is a file. content-type: (string) The MIME type of the file resource, if available. @since 2.12.0
tasks_import(\Horde_ActiveSync_Message_Task $message, string $tasklist = null) : string
Import a single task into the backend.
\Horde_ActiveSync_Message_Task | $message | The task message object |
string | $tasklist | The tasklist id. @since 2.12.0 |
The newly added task's uid.
tasks_getActionTimestamp(string $uid, string $action, $tasklist = null) : integer
Return the timestamp or modseq for the last time $action was performed.
string | $uid | The UID of the task we are interested in. |
string | $action | The action we are interested in (add, modify...) |
$tasklist |
notes_listUids(string $notepad = null) : array
List all notes in the user's default notepad.
string | $notepad | The notepad id to list. If null, use multiplexed. @since 2.12.0 |
An array of note uids.
since | 5.1 |
---|
notes_export(string $uid, array $options = array()) : \Horde_ActiveSync_Message_Note
Export a single note from the backend.
string | $uid | The note uid |
array | $options | Options to pass to the backend exporter. |
The note message object
since | 5.1 |
---|
notes_import(\Horde_ActiveSync_Message_Note $message, string $notebook = null) : string
Importa a single note into the backend.
\Horde_ActiveSync_Message_Note | $message | The note message object |
string | $notebook | The notebook id. @since 2.12.0 |
The newly added notes's uid.
since | 5.1 |
---|
notes_replace(string $uid, \Horde_ActiveSync_Message_Note $message)
Replace an existing task with the provided task.
string | $uid | The existing tasks's uid |
\Horde_ActiveSync_Message_Note | $message | The task object |
since | 5.1 |
---|
notes_delete(string $id)
Delete a note from the backend.
string | $id | The task's uid |
since | 5.1 |
---|
notes_getActionTimestamp(string $uid, string $action, string $notepad = null) : integer
Return the timestamp for the last time $action was performed.
string | $uid | The UID of the task we are interested in. |
string | $action | The action we are interested in (add, modify...) |
string | $notepad | The notepad to use, if not using multiplex. |
since | 5.1 |
---|
horde_listApis() : array
Return all active api interfaces.
An array of interface names.
None found |
hasFeature(string $feature, string $collection) : boolean
Return if the backend collection has the requested feature.
string | $feature | The requested feature. |
string | $collection | The requested collection id. |
since | 2.6.0 |
---|
getHighestModSeq( $collection, $id = null) : integer
Return the highest modification sequence value for the specified collection
$collection | ||
$id |
The modseq value.
since | 2.6.0 |
---|
horde_getPref(string $app, string $pref) : mixed
Obtain a user's preference setting.
string | $app | The Horde application providing the setting. |
string | $pref | The name of the preference setting. |
The preference value
None found |
horde_hasInterface(string $api) : string
Obtain the name of the Horde application that provides the specified api interface.
string | $api | The interface name |
The application name.
None found |
horde_hasMethod(string $method, string $api) : boolean
Wrapper around Horde_Registry::hasMethod.
string | $method | The method name. |
string | $api | The API to check. |
None found |
filters_getVacation() : array|boolean
Return the currently set vacation message details.
The vacation rule properties or false if interface unavailable.
None found |
filters_setVacation(array $setting)
Set vacation message properties.
array | $setting | The vacation details. |
None found |
mail_getMaillog(string $mid) : \Horde_History_Log|false
Return a Maillog entry for the specified Message-ID.
string | $mid | The Message-ID of the message. |
The history log or false if not found.
None found |
mail_logMaillog(string $action, string $mid, string $recipients = null, string $folder = null)
Log a forward/reply action to the maillog.
string | $action | The action to log. One of: 'forward', 'reply', 'reply_all'. |
string | $mid | The Message-ID to log. |
string | $recipients | The recipients the mail was forwarded to. |
string | $folder | The sent-mail folder. @since Horde_Core 2.27.0 |
None found |
mail_logRecipient( $action, $recipients, $message_id)
$action | ||
$recipients | ||
$message_id |
None found |
mail_getMaillogChanges(integer $ts) : array
Poll the maillog for changes since the specified timestamp.
integer | $ts | The timestamp to check since. |
An array of Message-IDs that have changed since $ts.
None found |
mail_ensureMessageFlags(array $flags)
Add any user-defined flags to IMP's preferences.
array | $flags | An array of flags to add. |
None found |
getChanges(string $collection, integer $from_ts, integer $to_ts, string $server_id) : array
Get all server changes for the specified collection
string | $collection | The collection type (a Horde interface name - calendar, contacts, tasks) |
integer | $from_ts | Starting timestamp or modification sequence. |
integer | $to_ts | Ending timestamp or modification sequence. |
string | $server_id | The server id of the collection. If null, uses multiplexed. |
Horde_Exception
A hash of add, modify, and delete uids
None found |
softDelete(string $collection, \long $from_ts, \long $to_ts, string $source = null) : array
Return message UIDs that should be SOFTDELETEd from the client.
string | $collection | The collection type. |
\long | $from_ts | The start of the time period to search. |
\long | $to_ts | The end of the time period to search. |
string | $source | Limit to this source only. @since 2.12.0 |
An array of message UIDs that occur within the $from_ts and $to_ts range that are to be SOFTDELETEd from the client.
None found |
getFolders(string $collection, integer $multiplex) : array|string
Return the list of folders to sync for the specified collection.
string | $collection | The collection class A HordeActiveSync::CLASS* constant. |
integer | $multiplex | A bitmask flagging the collections that must be multiplexed, regardless of horde's settings |
A list of folder uids or $collection if supporting API is not found. If a list is returned, it is in the following format: 'uid' => array('display' => "Display Name", 'primary' => boolean)
since | 2.12.0 |
---|---|
todo |
H6 remove the hasMethod checks. |
createFolder(string $class, string $foldername) : string|integer
Create a new folder/source in the specified collection.
string | $class | The collection class. A HordeActiveSync::CLASS* constant. |
string | $foldername | The name of the new folder. |
The new folder serverid.
since | 2.12.0 |
---|
changeFolder(string $class, string $id, string $name)
Change an existing folder on the server.
string | $class | The collection class. A HordeActiveSync::CLASS* constant. |
string | $id | The existing serverid. |
string | $name | The new folder display name. |
since | 2.12.0 |
---|
deleteFolder(string $class, string $id)
Delete a folder.
string | $class | The EAS collection class. |
string | $id | The folder id |
since | 2.12.0 |
---|
_getAppFromCollectionId(string $collection) : string
Convert a collection id to a horde app name.
string | $collection | The collection id e.g., @Notes@. |
The horde application name e.g., nag.
None found |
_getInterfaceFromCollectionId(string $collection) : string
Normalize the collection ids to interface names.
string | $collection | The collection id e.g., @Notes@ |
The Horde interface name e.g., notes
None found |
_ensureCalendar(string $source) : array
Return an array of calendar sources - either the user's configured "default" calendar (if $source is empty) or the calendar specified by $soruce.
string | $source | The calendar id. |
An array containing the calendar id.
None found |