(Perl) Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

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

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

use chilkat();

$success = 0;

# 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.example.com");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

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

# Select an IMAP mailbox
$success = $imap->SelectMailbox("Inbox");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\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 = chilkat::CkMessageSet->new();
$success = $imap->QueryMbx("ALL",$fetchUids,$messageSet);
if ($success == 0) {
    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 = chilkat::CkEmailBundle->new();
$headersOnly = 1;
$success = $imap->FetchMsgSet($headersOnly,$messageSet,$bundle);
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

# Loop over the email objects and display information
# about each:
$email = chilkat::CkEmail->new();

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

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

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

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

    # 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);
    $j = 0;
    while ($j < $numAttach) {
        print $imap->getMailAttachFilename($email,$j) . "\r\n";
        $attachSize = $imap->GetMailAttachSize($email,$j);
        print "    size = " . $attachSize . " bytes" . "\r\n";
        $j = $j + 1;
    }

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

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