/usr/share/php/Horde/Kolab/Storage/Driver.php is in php-horde-kolab-storage 2.2.3-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 | <?php
/**
* The driver definition for accessing Kolab storage.
*
* PHP version 5
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
/**
* The driver definition for accessing Kolab storage.
*
* Copyright 2004-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Storage
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Storage
*/
interface Horde_Kolab_Storage_Driver
{
/** Generic functionality */
/**
* Create the backend driver.
*
* @return mixed The backend driver.
*/
public function createBackend();
/**
* Returns the actual backend driver.
*
* If there is no driver set the driver should be constructed within this
* method.
*
* @return mixed The backend driver.
*/
public function getBackend();
/**
* Set the backend driver.
*
* @param mixed $backend The driver that should be used.
*
* @return NULL
*/
public function setBackend($backend);
/**
* Return the id of the user currently authenticated.
*
* @return string The id of the user that opened the connection.
*/
public function getAuth();
/**
* Return the unique connection id.
*
* @return string The connection id.
*/
public function getId();
/**
* Return the connection parameters.
*
* @return array The connection parameters.
*/
public function getParameters();
/**
* Checks if the backend supports CATENATE.
*
* @return boolean True if the backend supports CATENATE.
*/
public function hasCatenateSupport();
/** List functionality */
/**
* Retrieves a list of folders from the server.
*
* @return array The list of folders.
*/
public function listFolders();
/**
* Create the specified folder.
*
* @param string $folder The folder to create.
*
* @return NULL
*/
public function create($folder);
/**
* Delete the specified folder.
*
* @param string $folder The folder to delete.
*
* @return NULL
*/
public function delete($folder);
/**
* Rename the specified folder.
*
* @param string $old The folder to rename.
* @param string $new The new name of the folder.
*
* @return NULL
*/
public function rename($old, $new);
/**
* Does the backend support ACL?
*
* @return boolean True if the backend supports ACLs.
*/
public function hasAclSupport();
/**
* Retrieve the access rights for a folder.
*
* @param string $folder The folder to retrieve the ACL for.
*
* @return array An array of rights.
*/
public function getAcl($folder);
/**
* Retrieve the access rights the current user has on a folder.
*
* @param string $folder The folder to retrieve the user ACL for.
*
* @return string The user rights.
*/
public function getMyAcl($folder);
/**
* Set the access rights for a folder.
*
* @param string $folder The folder to act upon.
* @param string $user The user to set the ACL for.
* @param string $acl The ACL.
*
* @return NULL
*/
public function setAcl($folder, $user, $acl);
/**
* Delete the access rights for user on a folder.
*
* @param string $folder The folder to act upon.
* @param string $user The user to delete the ACL for
*
* @return NULL
*/
public function deleteAcl($folder, $user);
/**
* Retrieves the specified annotation for the complete list of folders.
*
* @param string $annotation The name of the annotation to retrieve.
*
* @return array An associative array combining the folder names as key with
* the corresponding annotation value.
*/
public function listAnnotation($annotation);
/**
* Fetches the annotation from a folder.
*
* @param string $folder The name of the folder.
* @param string $annotation The annotation to get.
*
* @return string The annotation value.
*/
public function getAnnotation($folder, $annotation);
/**
* Sets the annotation on a folder.
*
* @param string $folder The name of the folder.
* @param string $annotation The annotation to set.
* @param array $value The values to set
*
* @return NULL
*/
public function setAnnotation($folder, $annotation, $value);
/**
* Retrieve the namespace information for this connection.
*
* @return Horde_Kolab_Storage_Driver_Namespace The initialized namespace handler.
*/
public function getNamespace();
/** Data functionality */
/**
* Returns a stamp for the current folder status. This stamp can be used to
* identify changes in the folder data.
*
* @param string $folder Return the stamp for this folder.
*
* @return Horde_Kolab_Storage_Folder_Stamp A stamp indicating the current
* folder status.
*/
public function getStamp($folder);
/**
* Returns the status of the current folder.
*
* @param string $folder Check the status of this folder.
*
* @return array An array that contains 'uidvalidity' and 'uidnext'.
*/
public function status($folder);
/**
* Returns the message ids of the messages in this folder.
*
* @param string $folder Check the status of this folder.
*
* @return array The message ids.
*/
public function getUids($folder);
/**
* Retrieves the messages for the given message ids.
*
* @param string $folder The folder to fetch the messages from.
* @param array $uids The message UIDs.
*
* @return array An array of message structures parsed into Horde_Mime_Part
* instances.
*/
public function fetchStructure($folder, $uids);
/**
* Retrieves a bodypart for the given message ID and mime part ID.
*
* @param string $folder The folder to fetch the messages from.
* @param array $uid The message UID.
* @param array $id The mime part ID.
*
* @return resource|string The body part, as a stream resource or string.
*/
public function fetchBodypart($folder, $uid, $id);
/**
* Retrieves a complete message.
*
* @param string $folder The folder to fetch the messages from.
* @param array $uid The message UID.
*
* @return array The message encapsuled as an array that contains a
* Horde_Mime_Headers and a Horde_Mime_Part object.
*/
public function fetchComplete($folder, $uid);
/**
* Retrieves the message headers.
*
* @param string $folder The folder to fetch the message from.
* @param array $uid The message UID.
*
* @return Horde_Mime_Headers The message headers.
*/
public function fetchHeaders($folder, $uid);
/**
* Appends a message to the given folder.
*
* @param string $folder The folder to append the message(s) to.
* @param resource $msg The message to append.
*
* @return mixed True or the UID of the new message in case the backend
* supports UIDPLUS.
*/
public function appendMessage($folder, $msg);
/**
* Deletes messages from the specified folder.
*
* @param string $folder The folder to delete messages from.
* @param integer $uids IMAP message ids.
*
* @return NULL
*/
public function deleteMessages($folder, $uids);
/**
* Moves a message to a new folder.
*
* @param integer $uid IMAP message id.
* @param string $old_folder Source folder.
* @param string $new_folder Target folder.
*
* @return NULL
*/
public function moveMessage($uid, $old_folder, $new_folder);
/**
* Expunges messages in the current folder.
*
* @param string $folder The folder to expunge.
*
* @return NULL
*/
public function expunge($folder);
}
|