(Visual FoxPro) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loImap
LOCAL lnSuccess
LOCAL lnFetchUids
LOCAL loMessageSet
LOCAL loBundle
LOCAL i
LOCAL lnSzBundle
LOCAL loMsOneMsg
LOCAL loEmail
LOCAL lcUidStr

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Imap')
loImap = CreateObject('Chilkat.Imap')

* Connect to an IMAP server.
* Use TLS
loImap.Ssl = 1
loImap.Port = 993
lnSuccess = loImap.Connect("imap.someMailServer.com")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Login
lnSuccess = loImap.Login("login","password")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Select an IMAP mailbox
lnSuccess = loImap.SelectMailbox("Inbox")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnFetchUids = 1
* Get the message UIDs of all the emails in the mailbox
loMessageSet = loImap.Search("ALL",lnFetchUids)
IF (loImap.LastMethodSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

loBundle = loImap.FetchHeaders(loMessageSet)
IF (loImap.LastMethodSuccess <> 1) THEN
    RELEASE loMessageSet
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* The UID of each fetched email header is available 
* in the ckx-imap-uid header field.
i = 0
lnSzBundle = loBundle.MessageCount
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.MessageSet')
loMsOneMsg = CreateObject('Chilkat.MessageSet')
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.
    lnSuccess = loImap.MoveMessages(loMsOneMsg,"someOtherFolder")
    IF (lnSuccess <> 1) THEN
        ? loImap.LastErrorText
        * Exit the loop...
        i = lnSzBundle
    ENDIF

    RELEASE loEmail
    i = i + 1
ENDDO

* Disconnect from the IMAP server.
lnSuccess = loImap.Disconnect()

RELEASE loMessageSet
RELEASE loBundle

RELEASE loImap
RELEASE loMsOneMsg