(Visual Basic 6.0) 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

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

Dim imap As New ChilkatImap

' Connect to an IMAP server.
' Use TLS
imap.Ssl = 1
imap.Port = 993
Dim success As Long
success = imap.Connect("imap.someMailServer.com")
If (success <> 1) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

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

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

Dim fetchUids As Long
fetchUids = 1
' Get the message UIDs of all the emails in the mailbox
Dim messageSet As MessageSet
Set messageSet = imap.Search("ALL",fetchUids)
If (imap.LastMethodSuccess <> 1) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

Dim bundle As ChilkatEmailBundle
Set bundle = imap.FetchHeaders(messageSet)
If (imap.LastMethodSuccess <> 1) 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.
Dim i As Long
i = 0
Dim szBundle As Long
szBundle = bundle.MessageCount
Dim msOneMsg As New MessageSet
Do While i < szBundle
    Dim email As ChilkatEmail
    Set email = bundle.GetEmail(i)

    ' Build a message set containing one UID
    Dim uidStr As String
    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
        Debug.Print imap.LastErrorText
        ' Exit the loop...
        i = szBundle
    End If

    i = i + 1
Loop

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