(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loImap = createobject("CkImap")

// Connect to an IMAP server.
// Use TLS
loImap.Ssl = .T.
loImap.Port = 993
llSuccess = loImap.Connect("imap.someMailServer.com")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Login
llSuccess = loImap.Login("login","password")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

// Select an IMAP mailbox
llSuccess = loImap.SelectMailbox("Inbox")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

llFetchUids = .T.
// Get the message UIDs of all the emails in the mailbox
loMessageSet = loImap.Search("ALL",llFetchUids)
if (loImap.LastMethodSuccess <> .T.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

loBundle = loImap.FetchHeaders(loMessageSet)
if (loImap.LastMethodSuccess <> .T.) then
    release loMessageSet
    ? loImap.LastErrorText
    release loImap
    return
endif

// The UID of each fetched email header is available 
// in the ckx-imap-uid header field.
i = 0
lnSzBundle = loBundle.MessageCount
loMsOneMsg = createobject("CkMessageSet")
do while i < lnSzBundle
    loEmail = loBundle.GetEmail(i)

    // Build a message set containing one UID
    lcUidStr = loEmail.GetHeaderField("ckx-imap-uid")
    loMsOneMsg.FromCompactString(lcUidStr)

    // Move this message to some other folder.
    llSuccess = loImap.MoveMessages(loMsOneMsg,"someOtherFolder")
    if (llSuccess <> .T.) then
        ? loImap.LastErrorText
        // Exit the loop...
        i = lnSzBundle
    endif

    release loEmail
    i = i + 1
enddo

// Disconnect from the IMAP server.
llSuccess = loImap.Disconnect()

release loMessageSet
release loBundle


release loImap
release loMsOneMsg