(PHP Extension) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// 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('login','password');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

$fetchUids = true;
// Get the message UIDs of all the emails in the mailbox
// messageSet is a CkMessageSet
$messageSet = $imap->Search('ALL',$fetchUids);
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// bundle is a CkEmailBundle
$bundle = $imap->FetchHeaders($messageSet);
if ($imap->get_LastMethodSuccess() != true) {

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

// The UID of each fetched email header is available 
// in the ckx-imap-uid header field.
$i = 0;
$szBundle = $bundle->get_MessageCount();
$msOneMsg = new CkMessageSet();
while ($i < $szBundle) {
    // email is a CkEmail
    $email = $bundle->GetEmail($i);

    // Build a message set containing one UID
    $uidStr = $email->getHeaderField('ckx-imap-uid');
    $msOneMsg->FromCompactString($uidStr);

    // Move this message to some other folder.
    $success = $imap->MoveMessages($msOneMsg,'someOtherFolder');
    if ($success != true) {
        print $imap->lastErrorText() . "\n";
        // Exit the loop...
        $i = $szBundle;
    }

    $i = $i + 1;
}

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


?>