(VB.NET) 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 .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

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

Dim imap As New Chilkat.Imap

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


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


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



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


Dim bundle As Chilkat.EmailBundle = imap.FetchHeaders(messageSet)
If (imap.LastMethodSuccess <> True) Then

    Debug.WriteLine(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 Integer = 0
Dim szBundle As Integer = bundle.MessageCount
Dim msOneMsg As New Chilkat.MessageSet
While i < szBundle
    Dim email As Chilkat.Email = bundle.GetEmail(i)

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

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



    i = i + 1
End While

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