(PHP ActiveX) Download an IMAP Message Set

Demonstrates how to read a set of IMAP emails.

Note: This example requires Chilkat v11.0.0 or greater.

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

$success = 0;

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

$imap = new COM("Chilkat.Imap");

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

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

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

// Search for messages with the word "test" in the subject.
$fetchUids = 1;

$messageSet = new COM("Chilkat.MessageSet");
$success = $imap->QueryMbx('Subject test',$fetchUids,$messageSet);
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Download the messages in a single call to FetchMsgSet.
// 
// 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 FetchMsgSet.
// 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 FetchMsgSet:

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

$bundle = new COM("Chilkat.EmailBundle");
$headersOnly = 0;
$success = $imap->FetchMsgSet($headersOnly,$messageSet,$bundle);
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Display the Subject and From of each email.
$email = new COM("Chilkat.Email");
$i = 0;
$numEmails = $bundle->MessageCount;
while ($i < $numEmails) {
    $bundle->EmailAt($i,$email);

    print $email->getHeaderField('Date') . "\n";
    print $email->Subject . "\n";
    print $email->From . "\n";
    print '--' . "\n";
    $i = $i + 1;
}


?>