Horde 3.1.3 : Vue détaillée de Admin.php

Classe: IMAP_Admin - X-Ref

The IMAP_Admin:: class allow managing of mailboxes on IMAP servers.

Required parameters:<pre>
'admin_user'      The name of a user with admin privileges.
'admin_password'  The password of the adminstrator.</pre>

Optional parameters:<pre>
'hostspec'       The hostname or IP address of the server.
DEFAULT: 'localhost'
'port'           The server port to which we will connect.
IMAP is generally 143, while IMAP-SSL is generally 993.
DEFAULT: 143
'protocol'       The connection protocol (e.g. 'imap', 'pop3', 'nntp').
Protocol is one of 'imap/notls' (or only 'imap' if you
have a c-client version 2000c or older), 'imap/ssl',
or 'imap/ssl/novalidate-cert' (for a self-signed
certificate).
DEFAULT: 'imap'
'userhierarchy'  The hierarchy where user mailboxes are stored.
DEFAULT: 'user.'
'dsn'            The full IMAP connection string.
If not present, this is built from 'hostspec', 'port'
and 'protocol' parameters.</pre>

$Horde: framework/IMAP/IMAP/Admin.php,v 1.5.6.9 2006/05/31 19:39:47 slusarz Exp $

Copyright 2004-2006 Jan Schneider <jan@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.

IMAP_Admin($params) X-Ref

Constructor.

param: array $params A hash with all necessary parameters

_connect() X-Ref

Connects to the IMAP server with the parameters passed to the
constructor.

return: resource|object An IMAP resource or a PEAR_Error on failure

addMailbox($mailbox) X-Ref

Adds a mailbox.

param: string $mailbox The mailbox name to add.
return: mixed True on success or a PEAR_Error object on failure.

_grantAdminPerms($mailbox) X-Ref

Grant the admin user all rights on the mailbox.

param: string $mailbox the name of the mailbox on which we will
return: mixed True if successful, or PEAR_Error on failure

removeMailbox($mailbox) X-Ref

Deletes a mailbox.

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

listMailboxes() X-Ref

List all mailboxes.

Note that this does not work on a virtual-domain enabled Cyrus (it will
only return mailboxes in the default domain).

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

mailboxExists($mailbox) X-Ref

Check whether a mailbox exists.

param: string $mailbox The mailbox to check.
return: mixed True if mailbox exists, false if not, or a PEAR_Error.

Poids:	224 lignes (8 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de Horde 3.1.3

/lib/Horde/IMAP/ -> Admin.php (sommaire)

Définit 1 class