PHP Extension

IMAP Delete Old Email (before a specified date)

See more IMAP Examples

Demonstrates how to delete email older than a particular date. PHP Extension

<?php

include("chilkat.php");

$success = false;

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

$imap = new CkImap();

// Connect to an IMAP server.
// Use TLS
$imap->put_Ssl(true);
$imap->put_Port(993);
// Use your IMAP server domain.  This example 
$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');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Get message ID's for emails older than 1/1/2025
$fetchUids = true;
$messageSet = new CkMessageSet();
$success = $imap->QueryMbx('SENTBEFORE 01-Jan-2025',$fetchUids,$messageSet);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// If desired, we can examine the Subject of each email to be deleted..
$email = new CkEmail();
$i = 0;
$count = $messageSet->get_Count();
$headerOnly = true;

while ($i < $count) {
    $success = $imap->FetchEmail($headerOnly,$messageSet->GetId($i),true,$email);
    if ($success == false) {
        print $imap->lastErrorText() . "\n";
        exit;
    }

    print $email->localDateStr() . "\n";
    print $email->subject() . "\n";

    $i = $i + 1;
}

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

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

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

?>