Class CyrusAdmin
Description
Cyrus Administrative Interface.
A limited API to the Cyrus Imap server.
Located in /api/CyrusAdmin.class.php (line 61)
Engine | --CyrusAdmin
Class Constant Summary
Variable Summary
Method Summary
Variables
mixed
$config
= null (line 69)
mixed
$host
= '127.0.0.1' (line 66)
mixed
$Imap
= null (line 70)
mixed
$is_loaded
= false (line 68)
mixed
$port
= '143' (line 67)
Inherited Variables
Inherited from Engine
Engine::$errors
Methods
Constructor __construct (line 85)
Cyrus Admin constructor.
CyrusAdmin
__construct
([string $host = '127.0.0.1'], [integer $port = '143'])
- string $host: string hostname to use. Defaults to 127.0.0.1
- integer $port: string Numeric port to user. Defaults to 2000.
Redefinition of:
- Engine::__construct()
- Engine constructor.
CreateFolder (line 202)
Creates a mailbox.
boolen
CreateFolder
(string $user, string $foldername)
- string $user: Name of the user to modify
- string $foldername: Name of folder to create
FolderExist (line 177)
check if the mailbox name exists
boolean
FolderExist
(string $user, string $foldername)
- string $user: the user to check
- string $foldername: the foldername to check
GetFolderList (line 133)
Returns a list of folders for a particular user.
array
GetFolderList
([ $folderMask = null], string $prepend)
- string $prepend: Optional string to prepend
- $folderMask
GetUserList (line 154)
Returns a list of users.
array
GetUserList
()
Login (line 115)
Connects and logs into the server.
void
Login
()
Inherited Methods
Inherited From Engine
Engine::__construct()
Engine::AddValidationError()
Engine::CheckValidationErrors()
Engine::CopyValidationErrors()
Engine::GetValidationErrors()
Engine::Log()
Engine::__destruct()
Class Constants
FILE_KOLAB_CONFIG
= '/etc/kolab/kolab.conf'
(line 72)
Inherited Constants
Inherited from Engine
Documentation generated on Fri, 28 Aug 2009 20:32:02 -0400 by phpDocumentor 1.3.2
