Class Mnemo_Driver_kolab

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

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 21) 

Mnemo_Driver
   |
   --Mnemo_Driver_kolab
Variable Summary
Description | Vars (details) | Methods (details)
Kolab $_kolab
Mnemo_Driver_kolab_wrapper $_wrapper
Method Summary
Description | Vars (details) | Methods (details)
Mnemo_Driver_kolab Mnemo_Driver_kolab ( $notepad, [ $params = array()])
mixed add (string $desc, string $body, [string $category = ''], [string $passphrase = null])
mixed delete (string $noteId)
mixed deleteAll ()
array get (string $noteId, [string $passphrase = null])
array getByUID (string $uid, [string $passphrase = null])
boolean initialize ()
booelan modify (integer $noteId, string $desc, string $body, [string $category = ''], [string $passphrase = null])
mixed move (string $noteId, string $newNotepad)
mixed retrieve ()
Variables
Description | Vars (details) | Methods (details)
Kolab $_kolab = null (line 28)

Our Kolab server connection.

Mnemo_Driver_kolab_wrapper $_wrapper = null (line 35)

The wrapper to decide between the Kolab implementation

Inherited Variables

Inherited from Mnemo_Driver

Mnemo_Driver::$_errormsg
 Mnemo_Driver::$_memos
 Mnemo_Driver::$_notepad
 Mnemo_Driver::$_pgp
Methods
Description | Vars (details) Methods (details)
Constructor Mnemo_Driver_kolab (line 37)
Mnemo_Driver_kolab Mnemo_Driver_kolab ( $notepad, [ $params = array()])
  • $notepad
  • $params
add (line 105)

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.
delete (line 146)

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 156)

Delete all notes from the current notepad

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

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 89)

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.
initialize (line 61)

Connect to the Kolab backend

  • return: True on success, PEAR_Error on failure.
boolean initialize ()
modify (line 121)

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 134)

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 166)

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

  • return: True on success, PEAR_Error on failure.
mixed retrieve ()
Redefinition of:
Mnemo_Driver::retrieve()
Retrieves notes from the database.

Inherited Methods

Inherited From Mnemo_Driver

Mnemo_Driver::Mnemo_Driver()
Mnemo_Driver::decrypt()
Mnemo_Driver::encrypt()
Mnemo_Driver::encryptionSupported()
Mnemo_Driver::factory()
Mnemo_Driver::fromiCalendar()
Mnemo_Driver::generateUID()
Mnemo_Driver::getMemoDescription()
Mnemo_Driver::listMemos()
Mnemo_Driver::loadPGP()
Mnemo_Driver::requireSecureConnection()
Mnemo_Driver::retrieve()
Mnemo_Driver::singleton()
Mnemo_Driver::toiCalendar()

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