PHP

Store One or More Flags on a Single Message

Demonstrates the Chilkat Imap.StoreFlags method, which sets or clears one or more flags on a single message identified by ID. The first argument is the message ID, the second (bUid) selects UID vs sequence number, the third is a space-separated list of flag names, and the fourth is the value (1 to set, 0 to clear). This example applies the Seen and Flagged flags to one message by UID.

Background: StoreFlags is the single-message counterpart to SetFlags and lets you change several flags at once by listing them space-separated (without leading backslashes). Because the ID can be either a UID or a sequence number, the bUid argument must match how you obtained it — a UID from a UID search, or a sequence number from a sequence-based operation. UIDs are the safer choice since they remain valid as the mailbox changes.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Imap;
use Chilkat2\MessageSet;

// Demonstrates the Imap.StoreFlags method, which sets or clears one or more flags on a single
// message identified by ID.  The 1st argument is the message ID, the 2nd (bUid) selects UID
// vs sequence number, the 3rd is a space-separated list of flag names, and the 4th is the
// value (1 to set, 0 to clear).

$imap = new Imap();

$imap->Ssl = true;
$imap->Port = 993;

try {
    $imap->Connect('imap.example.com');

    $imap->Login('user@example.com', 'myPassword');

    $imap->SelectMailbox('Inbox');

    // Get the UIDs of all messages.
    $msgSet = new MessageSet();
    $imap->QueryMbx('ALL', true, $msgSet);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

if ($msgSet->Count > 0) {
    // Apply the Seen and Flagged flags to the first message.  bUid is true because the ID
    // came from a UID search.
    $uid = $msgSet->GetId(0);
    try {
        $imap->StoreFlags($uid, true, 'Seen Flagged', 1);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    echo 'Updated flags on UID ', $uid, "\n";
}

try {
    $imap->Disconnect();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}