Mail_IMAP_ManageMB::manageMB()
bool manageMB(str $action, str $mb_name[, str $mb_rename])
This method is used to create/delete or rename a mailbox on the server.
Warning: This method is new and is thus experimental. Its API may be tweaked in future releases.
Method summary:
| param | str | $action One of create|delete|rename. Toggles which aspect of mailbox management is being invoked. |
| param | str | $mb_name The name of the mailbox to manage. The format of INBOX.$mb_name is assumed. |
| param | str | $mb_rename (optional) The new name of the mailbox to be renamed. The format of INBOX.$mb_rename is assumed. This argument is required if the $action is rename. |
| return | bool | |
| throws | ErrorStack: Unable to create mailbox. | Calling on imap_createmailbox failed, check syntax and try again, or the method is unsupported by the server. |
| throws | ErrorStack: No mailbox provided to rename. | The $mb_rename argument is empty. |
| throws | ErrorStack: Unable to rename mailbox. | Calling on imap_renamemailbox failed, check syntax and try again, or the method is unsupported by the server. |
| throws | ErrorStack: Unable to delete mailbox. | Calling on imap_deletemailbox failed, check syntax and try again, or the method is unsupported by the server. |
| throws | ErrorStack: Invalid action. | The $action argument must be one of create|rename|delete. |
| access | public | |
| see |
imap_createmailbox imap_renamemailbox imap_deletemailbox |
|
