PHP Extension

Get the Number of IMAP Attachments

Demonstrates the Chilkat Imap.GetMailNumAttach method, which returns the number of ordinary attachments on a message. The only argument is the Email. This example fetches only the headers and reports the attachment count.

Background: A header-only fetch downloads no attachment bodies, so the Email object's own downloaded-attachment count can be 0. GetMailNumAttach instead reads the ckx-imap-numAttach metadata, giving the true count — which is what you want when building a message list that shows whether each message has attachments.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the Imap.GetMailNumAttach method, which returns the number of ordinary
//  attachments on a message.  The only argument is the Email.

$imap = new CkImap();

$imap->put_Ssl(true);
$imap->put_Port(993);

$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$success = $imap->Login('user@example.com','myPassword');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$success = $imap->SelectMailbox('Inbox');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

//  Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
//  metadata describing the attachments is present, so the attachment info methods still work.
$headersOnly = true;
$useUid = false;
$seqNum = 1;
$email = new CkEmail();
$success = $imap->FetchEmail($headersOnly,$seqNum,$useUid,$email);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$numAttach = $imap->GetMailNumAttach($email);
print 'This message has ' . $numAttach . ' attachment(s).' . "\n";

$success = $imap->Disconnect();
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}


?>