renameMailbox() public method

Inbox cannot be renamed. Before calling this method, a connection to the IMAP server must be established and a user must be authenticated successfully.
public renameMailbox ( string $mailbox, string $newName ) : boolean
$mailbox string
$newName string
return boolean
ezcMailImapTransport Class Documentation
Beispiel #1
0
require_once 'tutorial_autoload.php';
// Create a new IMAP transport object by specifying the server name
$imap = new ezcMailImapTransport("imap.example.com");
// Authenticate to the IMAP server
$imap->authenticate("user", "password");
// Select the Inbox mailbox
$imap->selectMailbox('Inbox');
// List the capabilities of the IMAP server
$capabilities = $imap->capability();
// List existing mailboxes
$mailboxes = $imap->listMailboxes("", "*");
// Fetch the hierarchy delimiter character (usually "/")
$delimiter = $imap->getHierarchyDelimiter();
// Create a new mailbox
$imap->createMailbox("Reports 2006");
// Delete a mailbox
$imap->deleteMailbox("Reports 2005");
// Rename a mailbox
$imap->renameMailbox("Reports 2006", "Reports");
// Copy messages from the selected mailbox (here: Inbox) to another mailbox
$imap->copyMessages("1,2,4", "Reports");
// Set a flag to messages
// See the function description for a list of supported flags
$imap->setFlag("1,2,4", "DELETED");
// Clears a flag from messages
// See the function description for a list of supported flags
$imap->clearFlag("1,2,4", "SEEN");
// Append a message to a mailbox. $mail must contain the mail as text
// Use this with a "Sent" or "Drafts" mailbox
$imap->append("Sent", $mail);
Beispiel #2
0
 public function testRenameDeleteSelectedMailbox()
 {
     $imap = new ezcMailImapTransport(self::$server, self::$port);
     $imap->authenticate(self::$user, self::$password);
     $imap->createMailbox("Guybrush");
     $imap->selectMailbox("Guybrush");
     try {
         $imap->renameMailbox("Guybrush", "Elaine");
         $this->fail("Expected exception was not thrown");
     } catch (ezcMailTransportException $e) {
     }
     try {
         $imap->deleteMailbox("Guybrush");
         $this->fail("Expected exception was not thrown");
     } catch (ezcMailTransportException $e) {
     }
     $imap->selectMailbox("Inbox");
     $imap->deleteMailbox("Guybrush");
 }