(Chilkat2-Python) 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.

Chilkat2 Python Downloads install with pip pip3 install chilkat2 or download... Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

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

imap = chilkat2.Imap()

# Connect to an IMAP server.
# Use TLS
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.someMailServer.com")
if (success != True):
    print(imap.LastErrorText)
    sys.exit()

# Login
success = imap.Login("login","password")
if (success != True):
    print(imap.LastErrorText)
    sys.exit()

# Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
if (success != True):
    print(imap.LastErrorText)
    sys.exit()

fetchUids = True
# Get the message UIDs of all the emails in the mailbox
# messageSet is a CkMessageSet
messageSet = imap.Search("ALL",fetchUids)
if (imap.LastMethodSuccess != True):
    print(imap.LastErrorText)
    sys.exit()

# bundle is a CkEmailBundle
bundle = imap.FetchHeaders(messageSet)
if (imap.LastMethodSuccess != True):

    print(imap.LastErrorText)
    sys.exit()

# The UID of each fetched email header is available 
# in the ckx-imap-uid header field.
i = 0
szBundle = bundle.MessageCount
msOneMsg = chilkat2.MessageSet()
while i < szBundle :
    # email is a CkEmail
    email = bundle.GetEmail(i)

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

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

    i = i + 1

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