(VBScript) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

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

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

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Imap")
set imap = CreateObject("Chilkat.Imap")

' Connect to an IMAP server.
' Use TLS
imap.Ssl = 1
imap.Port = 993
success = imap.Connect("imap.someMailServer.com")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Login
success = imap.Login("login","password")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

fetchUids = 1
' Get the message UIDs of all the emails in the mailbox
' messageSet is a Chilkat.MessageSet
Set messageSet = imap.Search("ALL",fetchUids)
If (imap.LastMethodSuccess <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' bundle is a Chilkat.EmailBundle
Set bundle = imap.FetchHeaders(messageSet)
If (imap.LastMethodSuccess <> 1) Then

    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' The UID of each fetched email header is available 
' in the ckx-imap-uid header field.
i = 0
szBundle = bundle.MessageCount
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.MessageSet")
set msOneMsg = CreateObject("Chilkat.MessageSet")
Do While i < szBundle
    ' email is a Chilkat.Email
    Set email = bundle.GetEmail(i)

    ' Build a message set containing one UID
    uidStr = email.GetHeaderField("ckx-imap-uid")
    success = msOneMsg.FromCompactString(uidStr)

    ' Move this message to some other folder.
    success = imap.MoveMessages(msOneMsg,"someOtherFolder")
    If (success <> 1) Then
        outFile.WriteLine(imap.LastErrorText)
        ' Exit the loop...
        i = szBundle
    End If

    i = i + 1
Loop

' Disconnect from the IMAP server.
success = imap.Disconnect()


outFile.Close