Java

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 Java Downloads

Download Chilkat for Java

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Imap;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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).

        Imap imap = new Imap();

        imap.setSsl(true);
        imap.setPort(993);

        String statusXml;
        try {
            imap.connect("imap.example.com");

            imap.login("user@example.com", "myPassword");

            // Get the status of a mailbox (without selecting it).
            statusXml = imap.getMailboxStatus("Inbox");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println(statusXml);

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

        try {
            imap.disconnect();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }
    }
}