PHP Extension

Delete All IMAP Email

Demonstrates two ways to delete all email in a mailbox on an IMAP server. PHP Extension

<?php

include("chilkat.php");

$success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$imap = new CkImap();

// Turn on session logging:
$imap->put_KeepSessionLog(true);

// Connect to an IMAP server.
// Use TLS
$imap->put_Ssl(true);
$imap->put_Port(993);
$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Login
$success = $imap->Login('myLogin','myPassword');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Select an IMAP mailbox
$success = $imap->SelectMailbox('Inbox.RubyMail');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Get the complete set of Uids for email in the selected mailbox.
$messageSet = new CkMessageSet();
$success = $imap->QueryMbx('ALL',true,$messageSet);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Set the Deleted flag for each message.
// (ExpungeAndClose must be called to finalize the delete.)
$success = $imap->SetFlags($messageSet,'Deleted',1);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Alternatively, the Deleted flag may be set for each UID
// individiually, but this is less efficient:
$i = 0;
$n = $messageSet->get_Count();
while ($i < $n) {
    $success = $imap->SetFlag($messageSet->GetId($i),$messageSet->get_HasUids(),'Deleted',1);
    if ($success == false) {
        print $imap->lastErrorText() . "\n";
        exit;
    }

    $i = $i + 1;
}

// Expunge and close the mailbox.
$success = $imap->ExpungeAndClose();
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Display the session log.
print $imap->sessionLog() . "\n";

// Disconnect from the IMAP server.
$success = $imap->Disconnect();

?>