[ Index ]
 

Code source de IMP H3 (4.1.5)

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/lib/IMAP/ -> Client.php (sommaire)

(pas de description)

Poids: 663 lignes (22 kb)
Inclus ou requis: 2 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

IMP_IMAPClient:: (13 méthodes):
  IMP_IMAPClient()
  useTLS()
  _generateSid()
  _runCommand()
  _parseLine()
  _createStream()
  login()
  _login()
  logout()
  _capability()
  queryCapability()
  namespace()
  searchCharset()


Classe: IMP_IMAPClient  - X-Ref

The IMP_IMAPClient:: class enables connection to an IMAP server through
built-in PHP functions.

TODO: This should eventually be moved to Horde 4.0/framework.

$Horde: imp/lib/IMAP/Client.php,v 1.21.2.32 2007/07/10 09:59:00 slusarz Exp $

Copyright 2005-2007 Michael Slusarz <slusarz@horde.org>

Based on code from:
+ auth.php (1.49)
+ imap_general.php (1.212)
+ strings.php (1.184.2.35)
from the Squirrelmail project.
Copyright (c) 1999-2005 The SquirrelMail Project Team

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

IMP_IMAPClient($host, $port, $protocol)   X-Ref
Constructor.

param: string $host      The address/hostname of the IMAP server.
param: string $port      The port to connect to on the IMAP server.
param: string $protocol  The protocol string (See, e.g., servers.php).

useTLS()   X-Ref
Are we using TLS to connect and is it supported?

return: mixed  Returns true if TLS is being used to connect, false if

_generateSid()   X-Ref
Generates a new IMAP session ID by incrementing the last one used.

return: string  IMAP session id of the form 'A000'.

_runCommand($query)   X-Ref
Perform a command on the IMAP server.

param: string $query  The IMAP command to execute.
return: stdClass  Returns PEAR_Error on error.  On success, returns

_parseLine()   X-Ref
TODO

return: stdClass  See _runCommand().

_createStream()   X-Ref
Connects to the IMAP server.

return: mixed  Returns true on success, PEAR_Error on error.

login($username, $password)   X-Ref
Log the user into the IMAP server.

param: string $username  Username.
param: string $password  Encrypted password.
return: mixed  True on success, PEAR_Error on error.

_login($username, $password, $method)   X-Ref
Log the user into the IMAP server.

param: string $username  Username.
param: string $password  Encrypted password.
param: string $method    IMAP login method.
return: mixed  True on success, PEAR_Error on error.

logout()   X-Ref
Log out of the IMAP session.


_capability()   X-Ref
Get the CAPABILITY string from the IMAP server.


queryCapability($capability)   X-Ref
Returns whether the IMAP server supports the given capability.

param: string $capability  The capability string to query.
param: mixed  True if the server supports the queried capability,

namespace($additional = array()   X-Ref
Get the NAMESPACE information from the IMAP server.

param: array $additional  If the server supports namespaces, any
return: array  An array with the following format:

searchCharset($charset)   X-Ref
Determines whether the IMAP search command supports the optional
charset provided.

param: string $charset  The character set to test.
return: boolean  True if the IMAP search command supports the charset.



Généré le : Thu Nov 29 12:30:07 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics