Class Horde_Kolab_IMAP

Description

The Horde_Kolab_IMAP class provides a wrapper around two different Kolab IMAP connection types.

$Horde: framework/Kolab_Server/lib/Horde/Kolab/IMAP.php,v 1.1.2.2 2009/01/06 15:23:15 jan Exp $

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

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Kolab_Server/lib/Horde/Kolab/IMAP.php (line 23)


	
			
Direct descendents
Class Description
 class Horde_Kolab_IMAP_cclient The Horde_Kolab_IMAP_Connection_cclient class connects to an IMAP server using the IMAP functionality within PHP.
 class Horde_Kolab_IMAP_pear The Horde_Kolab_IMAP_Connection_pear class connects to an IMAP server using the Net_IMAP PEAR package.
 class Horde_Kolab_IMAP_test The Horde_Kolab_IMAP_Connection_test class simulates an IMAP server for testing purposes.
Variable Summary
 mixed $_imap
 int $_port
 string $_server
Method Summary
 static Horde_Kolab_IMAP|PEAR_Error &singleton (string $server, int $port, [boolean $annotation_required = true])
 Horde_Kolab_IMAP Horde_Kolab_IMAP (string $server, int $port)
 Horde_Kolab_IMAP|PEAR_Error &factory (string $server, int $port, [string $driver = 'cclient'])
Variables
mixed $_imap (line 44)

IMAP connection.

int $_port (line 37)

IMAP server port to connect to.

string $_reuse_detection (line 51)

Connection reuse detection signature.

string $_server (line 30)

IMAP server to connect to.

Methods
static singleton (line 79)

Attempts to return a reference to a concrete Horde_Kolab_IMAP instance.

It will only create a new instance if no Horde_Kolab_IMAP instance exists.

  • return: The concrete reference.
static Horde_Kolab_IMAP|PEAR_Error &singleton (string $server, int $port, [boolean $annotation_required = true])
  • string $server: Server name
  • int $port: Port
  • boolean $annotation_required: Do we actually need the annotation calls?
Constructor Horde_Kolab_IMAP (line 59)

Constructor.

Horde_Kolab_IMAP Horde_Kolab_IMAP (string $server, int $port)
  • string $server: Server to connect to
  • int $port: Port to connect to
factory (line 126)

Attempts to return a concrete Horde_Kolab_IMAP instance based on the available PHP functionality.

  • return: The newly created concrete Horde_Kolab_IMAP instance.
Horde_Kolab_IMAP|PEAR_Error &factory (string $server, int $port, [string $driver = 'cclient'])
  • string $server: Server name.
  • int $port: Server port.
  • string $driver: Which driver should we use?

Documentation generated on Sun, 30 Jan 2011 05:18:28 +0000 by phpDocumentor 1.4.3