Delphi ActiveX

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 Delphi ActiveX Downloads

Download Chilkat for Delphi ActiveX

Delphi ActiveX

var
success: Integer;
imap: TChilkatImap;
statusXml: WideString;

begin
success := 0;

//  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 := TChilkatImap.Create(Self);

imap.Ssl := 1;
imap.Port := 993;

success := imap.Connect('imap.example.com');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;
success := imap.Login('user@example.com','myPassword');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

//  Get the status of a mailbox (without selecting it).
statusXml := imap.GetMailboxStatus('Inbox');
if (imap.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;
Memo1.Lines.Add(statusXml);

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

success := imap.Disconnect();
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;