(PHP ActiveX) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Imap')
$imap = new COM("Chilkat.Imap");

// Connect using TLS.
$imap->Ssl = 1;
$imap->Port = 993;
$success = $imap->Connect('imap.example.com');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

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

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

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

print 'Number of messages = ' . $messageSet->Count . "\n";

$i = 0;
while ($i < $messageSet->Count) {
    // email is a Chilkat.Email
    $email = $imap->FetchSingle($messageSet->GetId($i),$fetchUids);
    if ($imap->LastMethodSuccess != 1) {
        print $imap->LastErrorText . "\n";

        exit;
    }

    print $email->From . '; ' . $email->Subject . "\n";

    $i = $i + 1;
}

print 'OK' . "\n";

?>