B4X Requires Chilkat v11.0.0+

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. B4X

Dim success As Boolean = False

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

Dim imap As ChilkatImap
imap.Initialize("imap")

'  Connect to an IMAP server.
'  Use TLS
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.example.com")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


'  Login
success = imap.Login("login", "password")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


'  Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


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

Dim messageSet As ChilkatMessageSet
messageSet.Initialize
success = imap.QueryMbx("ALL", fetchUids, messageSet)
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


Dim bundle As ChilkatEmailBundle
bundle.Initialize
Dim headersOnly As Boolean = True
success = imap.FetchMsgSet(headersOnly, messageSet, bundle)
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


'  The UID of each fetched email header is available 
'  in the ckx-imap-uid header field.
Dim email As ChilkatEmail
email.Initialize
Dim msgSet1 As ChilkatMessageSet
msgSet1.Initialize
Dim i As Int = 0
Dim szBundle As Int = bundle.MessageCount
Do While i < szBundle
    bundle.EmailAt(i, email)

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

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

    i = i + 1
Loop

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