(Delphi DLL) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, EmailBundle, Imap, Email, MessageSet;

...

procedure TForm1.Button1Click(Sender: TObject);
var
imap: HCkImap;
success: Boolean;
fetchUids: Boolean;
messageSet: HCkMessageSet;
bundle: HCkEmailBundle;
i: Integer;
szBundle: Integer;
msOneMsg: HCkMessageSet;
email: HCkEmail;
uidStr: PWideChar;

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

imap := CkImap_Create();

// Connect to an IMAP server.
// Use TLS
CkImap_putSsl(imap,True);
CkImap_putPort(imap,993);
success := CkImap_Connect(imap,'imap.someMailServer.com');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// Login
success := CkImap_Login(imap,'login','password');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// Select an IMAP mailbox
success := CkImap_SelectMailbox(imap,'Inbox');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

fetchUids := True;
// Get the message UIDs of all the emails in the mailbox
messageSet := CkImap_Search(imap,'ALL',fetchUids);
if (CkImap_getLastMethodSuccess(imap) <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

bundle := CkImap_FetchHeaders(imap,messageSet);
if (CkImap_getLastMethodSuccess(imap) <> True) then
  begin
    CkMessageSet_Dispose(messageSet);
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

// The UID of each fetched email header is available 
// in the ckx-imap-uid header field.
i := 0;
szBundle := CkEmailBundle_getMessageCount(bundle);
msOneMsg := CkMessageSet_Create();
while i < szBundle do
  begin
    email := CkEmailBundle_GetEmail(bundle,i);

    // Build a message set containing one UID
    uidStr := CkEmail__getHeaderField(email,'ckx-imap-uid');
    CkMessageSet_FromCompactString(msOneMsg,uidStr);

    // Move this message to some other folder.
    success := CkImap_MoveMessages(imap,msOneMsg,'someOtherFolder');
    if (success <> True) then
      begin
        Memo1.Lines.Add(CkImap__lastErrorText(imap));
        // Exit the loop...
        i := szBundle;
      end;

    CkEmail_Dispose(email);
    i := i + 1;
  end;

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

CkMessageSet_Dispose(messageSet);
CkEmailBundle_Dispose(bundle);

CkImap_Dispose(imap);
CkMessageSet_Dispose(msOneMsg);

end;