(DataFlex) Examine Junk/NonJunk Flags on Outlook.com and GMail

Examines the Junk and NonJunk FLAGS for IMAP on Outlook.com and GMail.com.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoImap
    Boolean iSuccess
    String sSelectResponse
    Integer iSequenceNum
    String sFlags
    Integer iMinSeqNum
    String sFlags
    String sTemp1

    Get Create (RefClass(cComChilkatImap)) To hoImap
    If (Not(IsComObjectCreated(hoImap))) Begin
        Send CreateComObject of hoImap
    End

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

    // Connect to the outlook.com IMAP server.
    // We'll do the same for GMail below..
    // Use TLS
    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993
    Get ComConnect Of hoImap "imap-mail.outlook.com" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Login
    Get ComLogin Of hoImap "myAccount@outlook.com" "OUTLOOK_PASSWORD" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Begin keeping a log of the session here.
    Set ComKeepSessionLog Of hoImap To True

    // Select an IMAP mailbox
    Get ComSelectMailbox Of hoImap "Inbox" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // The LastResponse property contains the full response of the last command.
    // The response to the SELECT mailbox command shows the FLAGS that can be set
    // for emails in the mailbox.
    Get ComLastResponse Of hoImap To sSelectResponse
    Showln sSelectResponse

    // The response to "SELECT Inbox" looks like this:
    // There are no FLAGS for Junk/NonJunk..

    // * 4 EXISTS
    // * 0 RECENT
    // * FLAGS (\Seen \Answered \Flagged \Deleted \Draft $MDNSent)
    // * OK [PERMANENTFLAGS (\Seen \Answered \Flagged \Deleted \Draft $MDNSent)] Permanent flags
    // * OK [UIDVALIDITY 14] UIDVALIDITY value
    // * OK [UIDNEXT 1719] The next unique identifier value
    // aaac OK [READ-WRITE] SELECT completed.

    // Fetch the flags for each message in the mailbox.
    // Prior to running this example, (using Mozilla Thunderbird) I marked one of the emails
    // in my outlook.com Inbox as Junk.  
    Move 1 To iSequenceNum
    While (iSequenceNum <= (ComNumMessages(hoImap)))
        Get ComFetchFlags Of hoImap iSequenceNum False To sFlags
        Showln iSequenceNum ": " sFlags
        Move (iSequenceNum + 1) To iSequenceNum
    Loop

    // The output of the above loop is this:

    // 	1: \Seen
    // 	2: \Seen
    // 	3: \Seen
    // 	4: \Seen

    // As you can see, nothing is marked as Junk/Spam.  This concurs with the list of FLAGS
    // documented in the response to the SELECT command.  Apparently, there is no flag for junk/nonjunk
    // for outlook.com.  Mozilla Thunderbird must be storing additional information about particular
    // emails locally.  (In other words, perhaps the Junk/NonJunk flag is information stored locally 
    // by Thunderbird, and is not a flag set on the server.)

    Showln "---- Session Log ----"
    Get ComSessionLog Of hoImap To sTemp1
    Showln sTemp1

    // The session log looks like this:

    // 	----IMAP REQUEST----
    // 	aaac SELECT "Inbox"
    // 	----IMAP RESPONSE----
    // 	* 4 EXISTS
    // 	* 0 RECENT
    // 	* FLAGS (\Seen \Answered \Flagged \Deleted \Draft $MDNSent)
    // 	* OK [PERMANENTFLAGS (\Seen \Answered \Flagged \Deleted \Draft $MDNSent)] Permanent flags
    // 	* OK [UIDVALIDITY 14] UIDVALIDITY value
    // 	* OK [UIDNEXT 1719] The next unique identifier value
    // 	aaac OK [READ-WRITE] SELECT completed.
    // 	----IMAP REQUEST----
    // 	aaad FETCH 1 (FLAGS)
    // 	----IMAP RESPONSE----
    // 	* 1 FETCH (FLAGS (\Seen))
    // 	aaad OK FETCH completed.
    // 	----IMAP REQUEST----
    // 	aaae FETCH 2 (FLAGS)
    // 	----IMAP RESPONSE----
    // 	* 2 FETCH (FLAGS (\Seen))
    // 	aaae OK FETCH completed.
    // 	----IMAP REQUEST----
    // 	aaaf FETCH 3 (FLAGS)
    // 	----IMAP RESPONSE----
    // 	* 3 FETCH (FLAGS (\Seen))
    // 	aaaf OK FETCH completed.
    // 	----IMAP REQUEST----
    // 	aaag FETCH 4 (FLAGS)
    // 	----IMAP RESPONSE----
    // 	* 4 FETCH (FLAGS (\Seen))
    // 	aaag OK FETCH completed.

    Get ComDisconnect Of hoImap To iSuccess

    // --------------------------------------------------------------------------------
    // Now let's check GMail..
    // Again, I've marked one email as Junk.

    Set ComKeepSessionLog Of hoImap To False
    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993
    Get ComConnect Of hoImap "imap.gmail.com" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Login
    Get ComLogin Of hoImap "myAccount@gmail.com" "GMAIL-IMAP-PASSWORD" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Set ComKeepSessionLog Of hoImap To True

    Get ComSelectMailbox Of hoImap "Inbox" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComLastResponse Of hoImap To sSelectResponse
    Showln sSelectResponse

    // The response to GMail "SELECT Inbox" 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 403404]
    // aaai OK [READ-WRITE] Inbox selected. (Success)

    Get ComNumMessages Of hoImap To iSequenceNum
    Move 1 To iMinSeqNum
    If (iSequenceNum > 10) Begin
        Move (iSequenceNum - 10) To iMinSeqNum
    End

    While (iSequenceNum >= iMinSeqNum)
        Get ComFetchFlags Of hoImap iSequenceNum False To sFlags
        Showln iSequenceNum ": " sFlags
        Move (iSequenceNum - 1) To iSequenceNum
    Loop

    // The output (for GMail) of the above loop is this:

    // 	46: Junk \Seen
    // 	45: NonJunk \Answered \Seen
    // 	44: NonJunk \Seen
    // 	43: \Answered \Seen
    // 	42: \Answered \Seen
    // 	41: NonJunk \Seen
    // 	40: NonJunk \Answered \Seen
    // 	39: NonJunk \Seen
    // 	38: NonJunk \Seen
    // 	37: NonJunk \Seen
    // 	36: NonJunk \Seen

    // As you can see, the email I marked as "Junk" using Mozilla Thunderbird has the Junk flag set.
    // This concurs with GMail's list of FLAGS.  Apparently, since the IMAP server has a "Junk" flag,
    // Thunderbird set it when I marked the email as Junk. 

    Get ComDisconnect Of hoImap To iSuccess


End_Procedure