(PHP ActiveX) IMAP Get List of Flags

When a mailbox is selected, the server response includes a list of flags:

The FLAGS response occurs as a result of a SELECT or EXAMINE command. The flag parenthesized list identifies the flags (at a minimum, the system-defined flags) that are applicable for this mailbox. Flags other than the system flags can also exist, depending on server implementation.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Imap')
$imap = new COM("Chilkat.Imap");

// This example assumes Chilkat Imap to have been previously unlocked.
// See Unlock Imap for sample code.

// Connect to an IMAP server.
// Use TLS
$imap->Ssl = 1;
$imap->Port = 993;
$success = $imap->Connect('MY-IMAP-DOMAIN');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

// Login
$success = $imap->Login('MY-IMAP-LOGIN','MY-IMAP-PASSWORD');
if ($success != 1) {
    print $imap->LastErrorText . "\n";
    exit;
}

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

// The LastResponse property contains the full response of the last command.
$selectResponse = $imap->LastResponse;
print $selectResponse . "\n";

// For example, on GMail, the SELECT response looks like this:

// 	* FLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk)
// 	* OK [PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk \*)] Flags permitted.
// 	* OK [UIDVALIDITY 3] UIDs valid.
// 	* 46 EXISTS
// 	* 0 RECENT
// 	* OK [UIDNEXT 4147] Predicted next UID.
// 	* OK [HIGHESTMODSEQ 402971]
// 	aaac OK [READ-WRITE] INBOX selected. (Success)

// The goal of this example is to capture the list of FLAGS.
// All IMAP servers will respond with the list of flags in a SPACE separated list enclosed in parentheses.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponse = new COM("Chilkat.StringBuilder");
$sbResponse->Append($selectResponse);

// Get just the list of flags:
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbFlagList = new COM("Chilkat.StringBuilder");
$sbFlagList->Append($sbResponse->getAfterBetween('* FLAGS','(',')'));
print $sbFlagList->getAsString() . "\n";

// sbFlagList contains this:  
// 
//     \Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk
// 

// Make sure no more than one SPACE char in a row exists.
$sbFlagList->TrimInsideSpaces();
// Modify sbFlagList to one flag per line
$numReplaced = $sbFlagList->Replace(' ','\r\n');

// Load a StringTable with the flag names.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringTable')
$flagsTable = new COM("Chilkat.StringTable");
$flagsTable->AppendFromSb($sbFlagList);

// Iterate over the individual flag names:
$i = 0;
while ($i < $flagsTable->Count) {
    print $i . ': ' . $flagsTable->stringAt($i) . "\n";
    $i = $i + 1;
}

// The output is:
// 
// 	0: \Answered
// 	1: \Flagged
// 	2: \Draft
// 	3: \Deleted
// 	4: \Seen
// 	5: $Forwarded
// 	6: $NotPhishing
// 	7: $Phishing
// 	8: $label1
// 	9: $label2
// 	10: $label3
// 	11: $label4
// 	12: $label5
// 	13: Junk
// 	14: NonJunk
// 

?>