(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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
success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Login
success = imap.Login("login","password")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim fetchUids As Boolean
fetchUids = True
// Get the message UIDs of all the emails in the mailbox
Dim messageSet As Chilkat.MessageSet
messageSet = imap.Search("ALL",fetchUids)
If (imap.LastMethodSuccess <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

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

    System.DebugLog(imap.LastErrorText)
    Return
End If

// The UID of each fetched email header is available 
// in the ckx-imap-uid header field.
Dim i As Int32
i = 0
Dim szBundle As Int32
szBundle = bundle.MessageCount
Dim msOneMsg As New Chilkat.MessageSet
While i < szBundle
    Dim email As Chilkat.Email
    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 <> True) Then
        System.DebugLog(imap.LastErrorText)
        // Exit the loop...
        i = szBundle
    End If

    i = i + 1
Wend

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