(PHP ActiveX) Download IMAP Message Set using FetchBundle

Demonstrates how to read IMAP emails using the FetchBundle method.

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 with the word "test" in the subject.
$fetchUids = 1;
// messageSet is a Chilkat.MessageSet
$messageSet = $imap->Search('Subject test',$fetchUids);
if ($imap->LastMethodSuccess != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Download the messages in a single call to FetchBundle.
// 
// This only makes sense if the number of emails to be downloaded is not too large.  
// For example, you wouldn't want to download 10000 emails in a single call to FetchBundle.
// Why? For two reasons:  (1) It could potentially cause an out-of-memory condition, and 
// (2) it would take an extremely large amount of time.  The longer the amount of time,
// the greater the likelihood of some kind of external networking or server problem occuring,
// and if it happens, then you would need to re-download everything from the beginning again.
// For large numbers of emails, it's better to loop over the emails in the message set
// and download/process one at a time as shown here: Download IMAP Messages One at a Time
// Downloading one message at a time makes it possible to resume the downloads rather than restart the entire operation all over again.

// If the message set is reasonable in size, you can download all at once using FetchBundle:

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

// bundle is a Chilkat.EmailBundle
$bundle = $imap->FetchBundle($messageSet);
if ($imap->LastMethodSuccess == 0) {

    print $imap->LastErrorText . "\n";
    exit;
}

// Display the Subject and From of each email.
$i = 0;
$numEmails = $bundle->MessageCount;
while ($i < $numEmails) {
    // email is a Chilkat.Email
    $email = $bundle->GetEmail($i);

    print $email->getHeaderField('Date') . "\n";
    print $email->Subject . "\n";
    print $email->From . "\n";
    print '--' . "\n";

    $i = $i + 1;
}


?>