[ 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/ -> api.php (sommaire)

IMP external API interface.

Poids: 305 lignes (9 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 3 fichiers
 lib/Session.php
 lib/IMAP.php
 lib/Folder.php

Définit 11 fonctions

  _imp_perms()
  _imp_authenticate()
  _imp_getStream()
  _imp_compose()
  _imp_batchCompose()
  _imp_folderlist()
  _imp_createFolder()
  _imp_server()
  _imp_addUser()
  _imp_removeUser()
  _imp_userList()

Fonctions
Fonctions qui ne font pas partie d'une Classe:

_imp_perms()   X-Ref
Pas de description

_imp_authenticate($userID, $credentials, $params)   X-Ref
TODO

param: string $userID       TODO
param: array  $credentials  TODO
param: array  $params       TODO
return: boolean  Whether IMP authentication was successful.

_imp_getStream($mailbox = null, $flags = 0)   X-Ref
Attempts to authenticate via IMP and return an IMAP stream.

param: string $mailbox  The mailbox name.
param: int $flags       IMAP connection flags.
return: mixed  An IMAP resource on success, false on failure.

_imp_compose($args = array()   X-Ref
Returns a compose window link.

param: string|array $args   List of arguments to pass to compose.php.
param: array $extra         Hash of extra, non-standard arguments to pass to
return: string  The link to the message composition screen.

_imp_batchCompose($args = array()   X-Ref
Return a list of compose window links.

param: mixed $args   List of lists of arguments to pass to compose.php. If
param: array $extra  List of hashes of extra, non-standard arguments to pass
return: string  The list of links to the message composition screen.

_imp_folderlist()   X-Ref
Returns the list of folders.

return: array  The list of IMAP folders.

_imp_createFolder($folder)   X-Ref
Creates a new folder.

param: string $folder  The UTF7-IMAP encoded name of the folder to create.
return: string  The full folder name created on success, an empty string

_imp_server()   X-Ref
Returns the currently logged on IMAP server.

return: string  The server hostname.  Returns null if the user has not

_imp_addUser($userId, $credentials)   X-Ref
Adds a set of authentication credentials.

param: string $userId       The userId to add.
param: array $credentials   The credentials to use.
return: boolean  True on success or a PEAR_Error object on failure.

_imp_removeUser($userId)   X-Ref
Deletes a set of authentication credentials.

param: string $userId  The userId to delete.
return: boolean  True on success or a PEAR_Error object on failure.

_imp_userList()   X-Ref
Lists all users in the system.

return: array  The array of userIds, or a PEAR_Error object on failure.



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