PHP Extension

Fetch a Chunk of Messages, Tracking Failures

Demonstrates the Chilkat Imap.FetchChunk2 method, which downloads a run of messages by sequence number and reports which succeeded and which failed. The arguments are the starting sequence number, the count, a MessageSet that receives the failed IDs, a MessageSet that receives the successfully-fetched IDs, and the EmailBundle. This example fetches the first chunk of messages and reports the success and failure counts.

Background: When bulk-downloading a large mailbox, individual messages can occasionally fail to fetch (a corrupt message on the server, a transient error) without failing the whole operation. FetchChunk2 is designed for that reality: it returns a partial EmailBundle plus two MessageSet objects so your code can log or retry exactly the messages that did not come through, rather than aborting the entire sync.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the Imap.FetchChunk2 method, which downloads a run of messages by sequence
//  number and reports which succeeded and which failed.  The 1st argument is the starting
//  sequence number, the 2nd is the count, the 3rd receives the failed IDs, the 4th receives
//  the successfully-fetched IDs, and the 5th is the EmailBundle.

$imap = new CkImap();

$imap->put_Ssl(true);
$imap->put_Port(993);

$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

$numMessages = $imap->SelectMailbox('Inbox');
if ($numMessages < 0) {
    print $imap->lastErrorText() . "\n";
    exit;
}

//  Fetch messages 1..25 (or fewer if the mailbox is smaller).
$count = 25;
if ($count > $numMessages) {
    $count = $numMessages;
}

$failedSet = new CkMessageSet();
$fetchedSet = new CkMessageSet();
$bundle = new CkEmailBundle();
$success = $imap->FetchChunk2(1,$count,$failedSet,$fetchedSet,$bundle);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print 'Fetched: ' . $fetchedSet->get_Count() . "\n";
print 'Failed:  ' . $failedSet->get_Count() . "\n";

$success = $imap->Disconnect();
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}


?>