Search an IMAP Mailbox

See more IMAP Examples

Demonstrates the Chilkat Imap.QueryMbx method, which searches the selected mailbox using IMAP search criteria and stores the matching message identifiers in a MessageSet. If bUid is true, the identifiers are UIDs; otherwise they are sequence numbers. This example finds unseen messages and lists their UIDs.

Background: IMAP search runs on the server, so you can find matching messages without downloading them. The criteria string is standard IMAP search syntax — for example UNSEEN, FROM "alice@example.com", SUBJECT "invoice", or SINCE 1-Jan-2026 — and terms can be combined. The result is a MessageSet of identifiers you then fetch, flag, copy, or move. Requesting UIDs (bUid = true) is preferred because UIDs remain valid across sessions.

Chilkat Go Downloads

Download Chilkat for Go

    success := false

    //  Demonstrates the Imap.QueryMbx method, which searches the selected mailbox using IMAP
    //  search criteria and stores the matching message identifiers in a MessageSet.  If bUid is
    //  true, the identifiers are UIDs; otherwise they are sequence numbers.

    imap := chilkat.NewImap()

    imap.SetSsl(true)
    imap.SetPort(993)

    success = imap.Connect("imap.example.com")
    if success == false {
        fmt.Println(imap.LastErrorText())
        imap.DisposeImap()
        return
    }

    success = imap.Login("user@example.com","myPassword")
    if success == false {
        fmt.Println(imap.LastErrorText())
        imap.DisposeImap()
        return
    }

    success = imap.SelectMailbox("Inbox")
    if success == false {
        fmt.Println(imap.LastErrorText())
        imap.DisposeImap()
        return
    }

    //  Search for unseen (unread) messages, returning their UIDs.
    msgSet := chilkat.NewMessageSet()
    success = imap.QueryMbx("UNSEEN",true,msgSet)
    if success == false {
        fmt.Println(imap.LastErrorText())
        imap.DisposeImap()
        msgSet.DisposeMessageSet()
        return
    }

    //  Iterate the matching message identifiers.
    n := msgSet.Count()
    fmt.Println("Matching messages: ", n)
    var i int
    for i = 0; i <= n - 1; i++ {
        fmt.Println("UID: ", msgSet.GetId(i))
    }

    success = imap.Disconnect()
    if success == false {
        fmt.Println(imap.LastErrorText())
        imap.DisposeImap()
        msgSet.DisposeMessageSet()
        return
    }


    imap.DisposeImap()
    msgSet.DisposeMessageSet()