(Perl) Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$imap = chilkat::CkImap->new();

# Connect to an IMAP server.
# Use TLS
$imap->put_Ssl(1);
$imap->put_Port(993);
$success = $imap->Connect("imap.someMailServer.com");
if ($success != 1) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

# Login
$success = $imap->Login("****","****");
if ($success != 1) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

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

# We can choose to fetch UIDs or sequence numbers.
$fetchUids = 1;
# Get the message IDs of all the emails in the mailbox
# messageSet is a MessageSet
$messageSet = $imap->Search("ALL",$fetchUids);
if ($imap->get_LastMethodSuccess() != 1) {
    print $imap->lastErrorText() . "\r\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 EmailBundle
$bundle = $imap->FetchHeaders($messageSet);
if ($imap->get_LastMethodSuccess() != 1) {

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

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

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

    # email is a Email
    $email = $bundle->GetEmail($i);

    # Display the From and Subject
    print $email->ck_from() . "\r\n";
    print $email->subject() . "\r\n";

    # Display the recipients:

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

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

    # Show the total size of the email, including body and attachments:
    print $email->get_Size() . "\r\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) . "\r\n";
        $attachSize = $imap->GetMailAttachSize($email,$j);
        print "    size = " . $attachSize . " bytes" . "\r\n";
    }

    print "--" . "\r\n";

}

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