PureBasic

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

IncludeFile "CkStringTable.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkImap.pb"

Procedure ChilkatExample()

    success.i = 0

    imap.i = CkImap::ckCreate()
    If imap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success = CkImap::ckConnect(imap,"MY-IMAP-DOMAIN")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Login
    success = CkImap::ckLogin(imap,"MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Select an IMAP mailbox
    success = CkImap::ckSelectMailbox(imap,"INBOX")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; The LastResponse property contains the full response of the last command.
    selectResponse.s = CkImap::ckLastResponse(imap)
    Debug 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.

    sbResponse.i = CkStringBuilder::ckCreate()
    If sbResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbResponse,selectResponse)

    ; Get just the list of flags:
    sbFlagList.i = CkStringBuilder::ckCreate()
    If sbFlagList.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbFlagList,CkStringBuilder::ckGetAfterBetween(sbResponse,"* FLAGS","(",")"))
    Debug CkStringBuilder::ckGetAsString(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::ckTrimInsideSpaces(sbFlagList)
    ; Modify sbFlagList to one flag per line
    numReplaced.i = CkStringBuilder::ckReplace(sbFlagList," ",Chr(13) + Chr(10))

    ; Load a StringTable with the flag names.
    flagsTable.i = CkStringTable::ckCreate()
    If flagsTable.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringTable::ckAppendFromSb(flagsTable,sbFlagList)

    ; Iterate over the individual flag names:
    i.i = 0
    While i < CkStringTable::ckCount(flagsTable)
        Debug Str(i) + ": " + CkStringTable::ckStringAt(flagsTable,i)
        i = i + 1
    Wend

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


    CkImap::ckDispose(imap)
    CkStringBuilder::ckDispose(sbResponse)
    CkStringBuilder::ckDispose(sbFlagList)
    CkStringTable::ckDispose(flagsTable)


    ProcedureReturn
EndProcedure