PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Imap
string ls_SelectResponse
oleobject loo_SbResponse
oleobject loo_SbFlagList
integer li_NumReplaced
oleobject loo_FlagsTable
integer i

li_Success = 0

loo_Imap = create oleobject
li_rc = loo_Imap.ConnectToNewObject("Chilkat.Imap")
if li_rc < 0 then
    destroy loo_Imap
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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
loo_Imap.Ssl = 1
loo_Imap.Port = 993
li_Success = loo_Imap.Connect("MY-IMAP-DOMAIN")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Login
li_Success = loo_Imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// Select an IMAP mailbox
li_Success = loo_Imap.SelectMailbox("INBOX")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

// The LastResponse property contains the full response of the last command.
ls_SelectResponse = loo_Imap.LastResponse
Write-Debug ls_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.

loo_SbResponse = create oleobject
li_rc = loo_SbResponse.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbResponse.Append(ls_SelectResponse)

// Get just the list of flags:
loo_SbFlagList = create oleobject
li_rc = loo_SbFlagList.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbFlagList.Append(loo_SbResponse.GetAfterBetween("* FLAGS","(",")"))
Write-Debug loo_SbFlagList.GetAsString()

// 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.
loo_SbFlagList.TrimInsideSpaces()
// Modify sbFlagList to one flag per line
li_NumReplaced = loo_SbFlagList.Replace(" ","~r~n")

// Load a StringTable with the flag names.
loo_FlagsTable = create oleobject
li_rc = loo_FlagsTable.ConnectToNewObject("Chilkat.StringTable")

loo_FlagsTable.AppendFromSb(loo_SbFlagList)

// Iterate over the individual flag names:
i = 0
do while i < loo_FlagsTable.Count
    Write-Debug string(i) + ": " + loo_FlagsTable.StringAt(i)
    i = i + 1
loop

// 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
// 


destroy loo_Imap
destroy loo_SbResponse
destroy loo_SbFlagList
destroy loo_FlagsTable