VBScript

Fetch the Flags Set on an IMAP Message

Demonstrates the Chilkat Imap.FetchFlags method, which returns the flags currently set on a single message as a space-separated string. The first argument is the message ID and the second (bUid) selects UID vs sequence number. This example fetches and prints the flags for one message identified by UID.

Background: The returned string is the server's current flag list for the message, such as \Seen \Flagged. This is a quick way to check a single message's state — for example, to decide whether it still needs processing — without downloading the message itself. To read the same information from a message you already have as an Email object, use GetMailFlag instead.

Chilkat VBScript Downloads

Download Chilkat for VBScript

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

'  Demonstrates the Imap.FetchFlags method, which returns the flags currently set on a single
'  message as a space-separated string.  The 1st argument is the message ID and the 2nd (bUid)
'  selects UID vs sequence number.

set imap = CreateObject("Chilkat.Imap")

imap.Ssl = 1
imap.Port = 993

success = imap.Connect("imap.example.com")
If (success = 0) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

success = imap.Login("user@example.com","myPassword")
If (success = 0) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

success = imap.SelectMailbox("Inbox")
If (success = 0) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

set msgSet = CreateObject("Chilkat.MessageSet")
success = imap.QueryMbx("ALL",1,msgSet)
If (success = 0) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

If (msgSet.Count > 0) Then
    uid = msgSet.GetId(0)
    '  FetchFlags returns a string, so assign it to a string variable and check for success.
    flags = imap.FetchFlags(uid,1)
    If (imap.LastMethodSuccess = 0) Then
        outFile.WriteLine(imap.LastErrorText)
        WScript.Quit
    End If

    outFile.WriteLine("UID " & uid & " flags: " & flags)
End If

success = imap.Disconnect()
If (success = 0) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If


outFile.Close