(PHP Extension) Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

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 requires 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() != true) {
    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 is a CkEmailBundle
$bundle = $imap->FetchHeaders($messageSet);
if ($imap->get_LastMethodSuccess() != true) {

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

// Loop over the email objects and display information
// about each:

for ($i = 0; $i <= $bundle->get_MessageCount() - 1; $i++) {

    // email is a CkEmail
    $email = $bundle->GetEmail($i);

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

    // Display the recipients:

    for ($j = 0; $j <= $email->get_NumTo() - 1; $j++) {
        $name = $email->getToName($j);
        $addr = $email->getToAddr($j);
        print $name . ', ' . $addr . "\n";
    }

    for ($j = 0; $j <= $email->get_NumCC() - 1; $j++) {
        $name = $email->getCcName($j);
        $addr = $email->getCcAddr($j);
        print $name . ', ' . $addr . "\n";
    }

    // Show the total size of the email, including body and attachments:
    print $email->get_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);
    for ($j = 0; $j <= $numAttach - 1; $j++) {
        print $imap->getMailAttachFilename($email,$j) . "\n";
        $attachSize = $imap->GetMailAttachSize($email,$j);
        print '    size = ' . $attachSize . ' bytes' . "\n";
    }

    print '--' . "\n";

}

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


?>