(PHP Extension) Determine the Number of Unseen Email Messages

Demonstrates how to determine how many unseen messages exist in an email account on an IMAP server.

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;
}

// After selecting the mailbox. the total number of emails
// is immediately available:
$totalNum = $imap->get_NumMessages();
print 'Num messages = ' . $totalNum . "\n";

// To determine the number of unseen messages, a call
// to Search is required, which returns the set of UIDs
// of all unseen messages.

// We can choose to fetch UIDs or sequence numbers.
$fetchUids = true;

// messageSet is a CkMessageSet
$messageSet = $imap->Search('UNSEEN',$fetchUids);
if ($imap->get_LastMethodSuccess() == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$numUnseen = $messageSet->get_Count();
print $numUnseen . "\n";

print 'UIDs ----' . "\n";

// Display the UIDs
$i = 0;

while ($i < $messageSet->get_Count()) {
    $msgId = $messageSet->GetId($i);
    print $msgId . "\n";
    $i = $i + 1;
}

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


?>