PHP Extension

Open an IMAP Mailbox Read-Only

Demonstrates the Chilkat Imap.ExamineMailbox method, which opens a mailbox as read-only. Use it instead of SelectMailbox when the application must not change message state, such as the \Seen flag. This example examines the Inbox.

Background: Reading a message can have a side effect: fetching its body normally sets the \Seen flag, marking it as read. ExamineMailbox corresponds to IMAP's EXAMINE command, which opens the mailbox in a read-only mode where no such changes are made — ideal for scanning, indexing, or backup tools that must leave the user's mailbox exactly as they left it.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the Imap.ExamineMailbox method, which opens a mailbox as read-only.  Use this
//  instead of SelectMailbox when the application must not change message state (such as the
//  \Seen flag).

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

//  Open the Inbox as read-only.
$success = $imap->ExamineMailbox('Inbox');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print 'Inbox opened read-only.' . "\n";

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


?>