Tcl

IMAP Get List of Flags

See more IMAP Examples

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.

This example demonstrates how to capture the SELECT (or EXAMINE) response, and parse the list of flags. Tcl

load ./chilkat.dll

set success 0

set imap [new_CkImap]

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# Connect to an IMAP server.
# Use TLS
CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993
set success [CkImap_Connect $imap "MY-IMAP-DOMAIN"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Login
set success [CkImap_Login $imap "MY-IMAP-LOGIN" "MY-IMAP-PASSWORD"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Select an IMAP mailbox
set success [CkImap_SelectMailbox $imap "INBOX"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# The LastResponse property contains the full response of the last command.
set selectResponse [CkImap_lastResponse $imap]
puts "$selectResponse"

# 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.

set sbResponse [new_CkStringBuilder]

CkStringBuilder_Append $sbResponse $selectResponse

# Get just the list of flags:
set sbFlagList [new_CkStringBuilder]

CkStringBuilder_Append $sbFlagList [CkStringBuilder_getAfterBetween $sbResponse "* FLAGS" "(" ")"]
puts [CkStringBuilder_getAsString $sbFlagList]

# 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.
CkStringBuilder_TrimInsideSpaces $sbFlagList
# Modify sbFlagList to one flag per line
set numReplaced [CkStringBuilder_Replace $sbFlagList " " "\r\n"]

# Load a StringTable with the flag names.
set flagsTable [new_CkStringTable]

CkStringTable_AppendFromSb $flagsTable $sbFlagList

# Iterate over the individual flag names:
set i 0
while {$i < [CkStringTable_get_Count $flagsTable]} {
    puts "$i: [CkStringTable_stringAt $flagsTable $i]"
    set i [expr $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
# 

delete_CkImap $imap
delete_CkStringBuilder $sbResponse
delete_CkStringBuilder $sbFlagList
delete_CkStringTable $flagsTable