Public Method Details |
createMailbox |
public boolean createMailbox( string $path, string &$errmsg )
|
|
Create a new mailbox in the imap mailbox tree
A new mailbox is created in the mailbox tree located where $path pointsto.
|
Parameter |
|
string |
$path |
|
|
Path and name of the new mailbox |
|
|
string |
&$errmsg |
|
|
Reference for storing error messages in case of a failure |
|
Returns |
boolean True on success, false otherwise |
|
deleteMailbox |
public boolean deleteMailbox( string $path, string &$errmsg )
|
|
Deletes a mailbox in the imap mailbox tree
Removes the mailbox where $path is pointing to and all its contents.
|
Parameter |
|
string |
$path |
|
|
Path and name of the mailbox |
|
|
string |
&$errmsg |
|
|
Reference for storing error messages in case of a failure |
|
Returns |
boolean True on success, false otherwise |
|
listMailbox |
public boolean listMailbox( string $path, array &$result, string &$errmsg )
|
|
List the names of all mailboxs below the given mailbox
Retrieves a list of all mailboxes which are located below the mailboxspecified by $path. The retrieved names are stored in the &$resultreference.
|
Parameter |
|
string |
$path |
|
|
Path of the base mailbox |
|
|
array |
&$result |
|
|
Reference for storing the retrieved names of the mailboxes |
|
|
string |
&$errmsg |
|
|
Reference for storing error messages in case of a failure |
|
Returns |
boolean True on success, false otherwise |
|
renameMailbox |
public boolean renameMailbox( string $oldpath, string $newpath, string &$errmsg )
|
|
Rename a mailbox
Changes the name of a mailbox to a new one. This does not work on rootmailboxes and only on mailbox folders. It is also not possible to move amailbox to a different location.
|
Parameter |
|
string |
$oldpath |
|
|
Name of the old mailbox |
|
|
string |
$newpath |
|
|
Name of the new mailbox |
|
|
string |
&$errmsg |
|
|
Reference for storing error messages in case of a failure |
|
Returns |
boolean True on success, false otherwise |
|
getQuota |
public boolean getQuota( string $path, int &$result, string &$errmsg )
|
|
Get the quota of a mailbox
Retrieves the maximum amount of space in kilobytes for mails in amailbox. This is also known as the "limit".
|
Parameter |
|
string |
$path |
|
|
Path to the mailbox |
|
|
int |
&$result |
|
|
Reference for storing the quota number |
|
|
string |
&$errmsg |
|
|
Reference for storing error messages in case of a failure |
|
Returns |
boolean True on success, false otherwise |
|
setQuota |
public boolean setQuota( string $path, int $limit, string &$errmsg )
|
|
Set the quota of a mailbox
Sets the maximum amount of space for mails in a mailbox. This is alsoknown as the "limit".
|
Parameter |
|
string |
$path |
|
|
Path to the mailbox |
|
|
int |
$limit |
|
|
Limit of this mailbox in kilobytes |
|
|
string |
&$errmsg |
|
|
Reference for storing error messages in case of a failure |
|
Returns |
boolean True on success, false otherwise |
|