(Xojo Plugin) Determine the Number of Unseen Email Messages

Demonstrates how to determine how many unseen messages exist in an email account on an IMAP server.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim imap As New Chilkat.Imap

// Connect to an IMAP server.
// Use TLS
imap.Ssl = True
imap.Port = 993
Dim success As Boolean
success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Login
success = imap.Login("***","***")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// After selecting the mailbox. the total number of emails
// is immediately available:
Dim totalNum As Int32
totalNum = imap.NumMessages
System.DebugLog("Num messages = " + Str(totalNum))

// To determine the number of unseen messages, a call
// to Search is required, which returns the set of UIDs
// of all unseen messages.

// We can choose to fetch UIDs or sequence numbers.
Dim fetchUids As Boolean
fetchUids = True

Dim messageSet As Chilkat.MessageSet
messageSet = imap.Search("UNSEEN",fetchUids)
If (imap.LastMethodSuccess = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim numUnseen As Int32
numUnseen = messageSet.Count
System.DebugLog(Str(numUnseen))

System.DebugLog("UIDs ----")

// Display the UIDs
Dim i As Int32
i = 0
Dim msgId As Int32
While i < messageSet.Count
    msgId = messageSet.GetId(i)
    System.DebugLog(Str(msgId))
    i = i + 1
Wend

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