Class Mnemo_Driver_kolab_wrapper_new

Description
Description | Vars (details) | Methods (details)

New Horde Mnemo driver for the Kolab IMAP server.

$Horde: mnemo/lib/Driver/kolab.php,v 1.7.2.12 2009/01/06 15:24:59 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file LICENSE for license information (ASL). If you did not receive this file, see http://www.horde.org/licenses/asl.php.

Located in /lib/Driver/kolab.php (line 472) 

Mnemo_Driver_kolab_wrapper
   |
   --Mnemo_Driver_kolab_wrapper_new
Variable Summary
Description | Vars (details) | Methods (details)
Kolab_IMAP $_store
Method Summary
Description | Vars (details) | Methods (details)
mixed add (string $desc, string $body, [string $category = ''], [string $passphrase = null])
mixed connect ()
mixed delete (string $noteId)
mixed deleteAll ()
array get (string $noteId, [string $passphrase = null])
array getByUID (string $uid, [string $passphrase = null])
booelan modify (integer $noteId, string $desc, string $body, [string $category = ''], [string $passphrase = null])
mixed move (string $noteId, string $newNotepad)
mixed retrieve ()
array _buildNote (array $note, [string $passphrase = null])
mixed _setObject (string $desc, string $body, [string $category = ''], [string $uid = null], [string $passphrase = null])
array _splitId (string $id)
string _uniqueId (string $id)
Variables
Description | Vars (details) | Methods (details)
Kolab_IMAP $_store = null (line 479)

Shortcut to the imap connection

Inherited Variables

Inherited from Mnemo_Driver_kolab_wrapper

Mnemo_Driver_kolab_wrapper::$_connected
 Mnemo_Driver_kolab_wrapper::$_driver
 Mnemo_Driver_kolab_wrapper::$_kolab
 Mnemo_Driver_kolab_wrapper::$_notepad
Methods
Description | Vars (details) Methods (details)
add (line 642)

Add a note to the backend storage.

  • return: The id of the note if successful, a PEAR error otherwise
mixed add (string $desc, string $body, [string $category = ''], [string $passphrase = null])
  • string $desc: The description (long) of the note.
  • string $body: The description (long) of the note.
  • string $category: The category of the note.
  • string $passphrase: The passphrase to encrypt the note with.
connect (line 486)

Connect to the Kolab backend

  • return: True on success, a PEAR error otherwise
mixed connect ()
Redefinition of:
Mnemo_Driver_kolab_wrapper::connect()
Connect to the Kolab backend
delete (line 690)

Delete the specified note from the current notepad

  • return: True on success, PEAR_Error on failure.
mixed delete (string $noteId)
  • string $noteId: The note to delete.
deleteAll (line 710)

Delete all notes from the current notepad

  • return: True on success, PEAR_Error on failure.
mixed deleteAll ()
get (line 548)

Retrieve one note from the store.

  • return: The array of note attributes.
array get (string $noteId, [string $passphrase = null])
  • string $noteId: The ID of the note to retrieve.
  • string $passphrase: A passphrase with which this note was supposed to be encrypted.
getByUID (line 569)

Retrieve one note by UID.

  • return: The array of note attributes.
array getByUID (string $uid, [string $passphrase = null])
  • string $uid: The UID of the note to retrieve.
  • string $passphrase: A passphrase with which this note was supposed to be encrypted.
modify (line 658)

Modify an existing note.

  • return: True if successful, a PEAR error otherwise.
booelan modify (integer $noteId, string $desc, string $body, [string $category = ''], [string $passphrase = null])
  • integer $noteId: The note to modify.
  • string $desc: The description (long) of the note.
  • string $body: The description (long) of the note.
  • string $category: The category of the note.
  • string $passphrase: The passphrase to encrypt the note with.
move (line 676)

Move a note to a new notepad.

  • return: True on success, PEAR_Error on failure.
mixed move (string $noteId, string $newNotepad)
  • string $noteId: The note to move.
  • string $newNotepad: The new notepad.
retrieve (line 720)

Retrieves all of the notes from $this->_notepad from the database.

  • return: True on success, PEAR_Error on failure.
mixed retrieve ()
_buildNote (line 749)

Build a note based on data array

  • return: The converted data array representing the note
array _buildNote (array $note, [string $passphrase = null])
  • array $note: The data for the note
  • string $passphrase: A passphrase for decrypting a note
_setObject (line 594)

Add or modify a note.

  • return: The id of the note if successful, a PEAR error otherwise
mixed _setObject (string $desc, string $body, [string $category = ''], [string $uid = null], [string $passphrase = null])
  • string $desc: The description (long) of the note.
  • string $body: The description (long) of the note.
  • string $category: The category of the note.
  • string $uid: The note to modify.
  • string $passphrase: The passphrase to encrypt the note with.
_splitId (line 511)

Split the notepad name of the id. We use this to make ids unique across folders.

  • return: The note id and notepad name
array _splitId (string $id)
  • string $id: The ID of the note appended with the notepad name.
_uniqueId (line 531)

Append the notepad name to the id. We use this to make ids unique across folders.

  • return: The note id appended with the notepad name.
string _uniqueId (string $id)
  • string $id: The ID of the note

Inherited Methods

Inherited From Mnemo_Driver_kolab_wrapper

Mnemo_Driver_kolab_wrapper::Mnemo_Driver_kolab_wrapper()
Mnemo_Driver_kolab_wrapper::connect()
Mnemo_Driver_kolab_wrapper::decrypt()
Mnemo_Driver_kolab_wrapper::encrypt()

Documentation generated on Sun, 30 Jan 2011 05:33:55 +0000 by phpDocumentor 1.4.3