Lianja

Get IMAP Mailbox Status

Demonstrates the Chilkat Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a mailbox and returns the reported values as XML attributes — including messages (total count), recent, uidnext, uidvalidity, and unseen. This example gets the Inbox status.

Tip: XML parsing code for this result can be generated at Chilkat Tools.

Background: STATUS queries a mailbox's summary counts without selecting it — ideal for showing unread counts across many folders in a UI, or checking whether a folder has new mail before deciding to open it. Two values are especially useful for sync: uidvalidity (if it changes, previously stored UIDs are no longer valid) and uidnext (the UID the next new message will get, so anything at or above a remembered value is new).

Chilkat Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

//  Demonstrates the Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a
//  mailbox and returns the reported values as XML attributes (such as messages, recent,
//  uidnext, uidvalidity, and unseen).

loImap = createobject("CkImap")

loImap.Ssl = .T.
loImap.Port = 993

llSuccess = loImap.Connect("imap.example.com")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

llSuccess = loImap.Login("user@example.com","myPassword")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

//  Get the status of a mailbox (without selecting it).
lcStatusXml = loImap.GetMailboxStatus("Inbox")
if (loImap.LastMethodSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

? lcStatusXml

//  XML parsing code for this result can be generated at Chilkat's online tool:
//  https://tools.chilkat.io/xmlParse

llSuccess = loImap.Disconnect()
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif



release loImap