(PHP ActiveX) Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

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 to an IMAP server.
// Use TLS
$imap->Ssl = 1;
$imap->Port = 993;
$success = $imap->Connect('imap.example.com');
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

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

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

// Get the message IDs of all the emails in the mailbox
// We can choose to fetch UIDs or sequence numbers.
$fetchUids = 1;
$messageSet = new COM("Chilkat.MessageSet");
$success = $imap->QueryMbx('ALL',$fetchUids,$messageSet);
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

// When downloading headers, each email object contains
// (obviously) the headers, but the body will be missing.
// Also, attachments will not be included.  However, it is
// possible to get information about the attachments
// as well as the complete size of the email.
$bundle = new COM("Chilkat.EmailBundle");
$headersOnly = 1;
$success = $imap->FetchMsgSet($headersOnly,$messageSet,$bundle);
if ($success == 0) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Loop over the email objects and display information
// about each:
$email = new COM("Chilkat.Email");

$i = 0;
$j = 0;
while ($i < $bundle->MessageCount) {
    $bundle->EmailAt($i,$email);

    // Display the From and Subject
    print $email->From . "\n";
    print $email->Subject . "\n";

    // Display the recipients:
    $j = 0;
    while ($j < $email->NumTo) {
        print 'TO: ' . $email->getToName($j) . ', ' . $email->getToAddr($j) . "\n";
        $j = $j + 1;
    }

    $j = 0;
    while ($j < $email->NumCC) {
        print 'CC: ' . $email->getCcName($j) . ', ' . $email->getCcAddr($j) . "\n";
        $j = $j + 1;
    }

    // Show the total size of the email, including body and attachments:
    print $email->Size . "\n";

    // When a full email is downloaded, we would use the
    // email.NumAttachments property in conjunction with the
    // email.GetMailAttach* methods.
    // However, when an email object contains only the header,
    // we need to access the attachment info differently:
    $numAttach = $imap->GetMailNumAttach($email);
    $j = 0;
    while ($j < $numAttach) {
        print $imap->getMailAttachFilename($email,$j) . "\n";
        $attachSize = $imap->GetMailAttachSize($email,$j);
        print '    size = ' . $attachSize . ' bytes' . "\n";
        $j = $j + 1;
    }

    print '--' . "\n";
}

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

?>