Xojo Plugin

Get IMAP UID from Email Header

See more IMAP Examples

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. Xojo Plugin

Dim success As Boolean
success = False

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

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

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success = False) 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 New Chilkat.MessageSet
success = imap.QueryMbx("ALL",fetchUids,messageSet)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim bundle As New Chilkat.EmailBundle
Dim headersOnly As Boolean
headersOnly = True
success = imap.FetchMsgSet(headersOnly,messageSet,bundle)
If (success = False) 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 email As New Chilkat.Email
Dim msgSet1 As New Chilkat.MessageSet
Dim i As Int32
i = 0
Dim szBundle As Int32
szBundle = bundle.MessageCount
While i < szBundle
    success = bundle.EmailAt(i,email)

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

    // Move this message to some other folder.
    success = imap.MoveMessages(msgSet1,"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()