Smiling Souls

Steeped in the delicious tea like leaves of anthroposophy for the evolving soul.

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 Error: Unable to create mailbox. Calling on imap_createmailbox() failed, check syntax and try again, or the method is unsupported by the server.
throws Error: No mailbox provided to rename. The $mb_rename argument is empty.
throws Error: Unable to rename mailbox. Calling on imap_renamemailbox failed, check syntax and try again, or the method is unsupported by the server.
throws Error: Unable to delete mailbox. Calling on imap_deletemailbox() failed, check syntax and try again, or the method is unsupported by the server.
throws Error: Invalid action. The $action argument must be one of create|rename|delete.
access public
see imap_createmailbox()
imap_renamemailbox()
imap_deletemailbox()

Comments

There are no comments posted at this time.

Leave a Comment

Simple HTML is allowed: <code>, <b>, <i>, <u>, <var>, <strong>, <em>, <blockquote>, <ul>, <ol>, <li>, <p> (no attributes). All spacing and line breaks in your comment will be preserved.

* All comments are moderated and are subject to approval.
Your comment will appear once it has been approved.
Posting multiple times will not expedite the approval process.

Comments are closed at this time.

© Copyright 2014 Hot Toddy, All Rights Reserved.