(PHP Extension) Fetch 1st N Headers of Search Results

Calls Search to get a message set, then downloads the 1st N messages in the message set. There are two equivalent ways of doing it: (1) iterate from 0 to N-1 and download each message individually, or (2) create a new message set that contains the 1st N messages and pass it to FetchHeaders. Both are demonstrated here.

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 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);
$success = $imap->Connect('imap.someMailServer.com');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

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

// We can choose to fetch UIDs or sequence numbers.
$fetchUids = true;
// Get the message IDs of all the emails in the mailbox
// messageSet is a CkMessageSet
$messageSet = $imap->Search('ALL',$fetchUids);
if ($imap->get_LastMethodSuccess() == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$numFound = $messageSet->get_Count();
if ($numFound == 0) {
    print 'No messages found.' . "\n";

    exit;
}

// Get the 1st 10 messages in messageSet.
$upperBound = 10;
if ($numFound < $upperBound) {
    $upperBound = $numFound;
}

$i = 0;
$bUid = $messageSet->get_HasUids();
while ($i < $upperBound) {

    // email is a CkEmail
    $email = $imap->FetchSingleHeader($messageSet->GetId($i),$bUid);
    if ($imap->get_LastMethodSuccess() == false) {
        print $imap->lastErrorText() . "\n";

        exit;

    }
    else {
        // Do whatever is needed with the email.. 
        // ....

    }

    $i = $i + 1;
}

// Alternatively, create a new message set containing the 1st 10 message id's (UID's) 
// from the search results message set:
$firstTen = new CkMessageSet();

for ($i = 0; $i <= $upperBound - 1; $i++) {
    $firstTen->InsertId($messageSet->GetId($i));
}

// Download the 1st ten headers:

// bundle is a CkEmailBundle
$bundle = $imap->FetchHeaders($firstTen);
if ($imap->get_LastMethodSuccess() == false) {

    print $imap->lastErrorText() . "\n";
    exit;
}

// Other examples show how to iterate over the emails contained within the bundle...

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


?>