PHP ActiveX Requires Chilkat v11.0.0+

Imap.GetMailSize vs Email.Size

Shows how to get the total size of an email, as well as the sizes of the attachments. This can be done when either full-emails or headers-only are downloaded. PHP ActiveX

<?php

$success = 0;

//  This example assumes 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.
//  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;
$numEmails = $bundle->MessageCount;
while ($i < $numEmails) {
    $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";

    $i = $i + 1;
}

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

?>