(Excel) 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.

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim imap As Chilkat.Imap
Set imap = Chilkat.NewImap

' Connect to an IMAP server.
' Use TLS
imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Login
success = imap.Login("login","password")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If


fetchUids = True
' Get the message UIDs of all the emails in the mailbox

Set messageSet = imap.Search("ALL",fetchUids)
If (imap.LastMethodSuccess <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If


Set bundle = imap.FetchHeaders(messageSet)
If (imap.LastMethodSuccess <> True) Then

    Debug.Print imap.LastErrorText
    Exit Sub
End If

' The UID of each fetched email header is available 
' in the ckx-imap-uid header field.

i = 0

szBundle = bundle.MessageCount
Dim msOneMsg As Chilkat.MessageSet
Set msOneMsg = Chilkat.NewMessageSet
Do While i < szBundle

    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 <> True) Then
        Debug.Print imap.LastErrorText
        ' Exit the loop...
        i = szBundle
    End If

    i = i + 1
Loop

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