CkPython

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

import sys
import chilkat

success = False

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

imap = chilkat.CkImap()

# Connect to an IMAP server.
# Use TLS
imap.put_Ssl(True)
imap.put_Port(993)
success = imap.Connect("imap.example.com")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

# Login
success = imap.Login("login","password")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

# Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

fetchUids = True
# Get the message UIDs of all the emails in the mailbox

messageSet = chilkat.CkMessageSet()
success = imap.QueryMbx("ALL",fetchUids,messageSet)
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

bundle = chilkat.CkEmailBundle()
headersOnly = True
success = imap.FetchMsgSet(headersOnly,messageSet,bundle)
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

# The UID of each fetched email header is available 
# in the ckx-imap-uid header field.
email = chilkat.CkEmail()
msgSet1 = chilkat.CkMessageSet()
i = 0
szBundle = bundle.get_MessageCount()
while i < szBundle :
    bundle.EmailAt(i,email)

    # Build a message set containing one UID
    uidStr = email.getHeaderField("ckx-imap-uid")
    msgSet1.FromCompactString(uidStr)

    # Move this message to some other folder.
    success = imap.MoveMessages(msgSet1,"someOtherFolder")
    if (success != True):
        print(imap.lastErrorText())
        # Exit the loop...
        i = szBundle

    i = i + 1

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