(PHP Extension) How to Download Messages in MessageSet One at a Time

If a message set contains a huge number of emails, it's NOT a good idea to try to download all at once into an email bundle using a method such as FetchBundle. It's better to iterate over the messages in the set to download one by one.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$imap = new CkImap();

// Connect using TLS.
$imap->put_Ssl(true);
$imap->put_Port(993);
$success = $imap->Connect('imap.example.com');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Authenticate
$success = $imap->Login('email_account_login','email_account_password');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

// Search for messages and return a set of matching messages.
// (This example will simply search for ALL messages.)
$fetchUids = true;
// messageSet is a CkMessageSet
$messageSet = $imap->Search('ALL',$fetchUids);
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print 'Number of messages = ' . $messageSet->get_Count() . "\n";

$i = 0;
while ($i < $messageSet->get_Count()) {
    // email is a CkEmail
    $email = $imap->FetchSingle($messageSet->GetId($i),$fetchUids);
    if ($imap->get_LastMethodSuccess() != true) {
        print $imap->lastErrorText() . "\n";

        exit;
    }

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

    $i = $i + 1;
}

print 'OK' . "\n";

?>