PHP Extension

How to Download Messages in MessageSet One at a Time

See more IMAP Examples

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. 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();

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

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

// Select an IMAP mailbox
$success = $imap->SelectMailbox('Inbox');
if ($success == false) {
    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 = new CkMessageSet();
$success = $imap->QueryMbx('ALL',$fetchUids,$messageSet);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

$email = new CkEmail();
$i = 0;
while ($i < $messageSet->get_Count()) {
    $success = $imap->FetchEmail(false,$messageSet->GetId($i),$fetchUids,$email);
    if ($success == false) {
        print $imap->lastErrorText() . "\n";
        exit;
    }

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

    $i = $i + 1;
}

print 'OK' . "\n";

?>