TPop3Cli.List

Main page -> ICS component reference -> TPop3Cli -> List

Definition

<syntaxhighlight lang="delphi"> procedure List; virtual; </syntaxhighlight>

Description

Sends LIST command to a POP3 server. The command can be issued in 2 modes - list mode and single mode. This command is valid in POP3 TRANSACTION state so you must issue it after you've successfully authenticated. To issue it in list mode set MsgNum property to 0 before calling this method. To issue it in single mode set MsgNum property to index of the message you want to get LIST for.

<syntaxhighlight lang="delphi"> // This will issue List in list mode (triggers OnList events) Pop3Cli.MsgNum := 0; Pop3Cli.List; </syntaxhighlight>

<syntaxhighlight lang="delphi"> // This will issue List in single mode for the message 1 (does not trigger OnList events) Pop3Cli.MsgNum := 1; Pop3Cli.List; </syntaxhighlight>

If the command is issued in single mode it returns the result from POP3 server in the next LastResponse property. Also, MsgSize will hold the size of the message in octets (bytes). If it is issued in list mode, LastResponse will be empty but it will trigger OnListBegin, OnListLine and OnListEnd events instead which you can use to appropriately handle the output from the LIST. When the events occur, MsgNum and MsgSize contain the appropriate values of the currently listed message that the event is generated for.

Delphi Example

For this example to work, drop a Memo, Pop3Cli and Button components on the form. Then, add OnClick event to the button and OnListBegin, OnListLine, OnListEnd and OnRequestDone events to the Pop3Cli component and use the following code.

<syntaxhighlight lang="delphi"> //--------------------------------------------------------------------------- Procedure TForm1.Button1Click(Sender: TObject) Begin

 // Clear the memo for clean output
 Memo1.Lines.Clear();

 // Fill the following with your actual server details
 Pop3Cli1.Host     := "pop3.yourserver.com";
 Pop3Cli1.UserName := "username";
 Pop3Cli1.PassWord := "password";
 Pop3Cli1.Connect();

End;

//--------------------------------------------------------------------------- Procedure TForm1.Pop3Cli1RequestDone(Sender: TObject; RqType: TPop3Request; Error: WORD) Var

 ListAll: Boolean;

Begin

 // Toggle this to change the behaviour of LIST command from single to list and back
 ListAll := true;

 If (Error = 0) Then Begin
   If (Pop3Cli1.LastResponse <> ) Then
     Memo1.Lines.Add(Pop3Cli1.LastResponse);

   Case (RqType) Of
     Case pop3Connect: Pop3Cli1.User();
     Case pop3User:    Pop3Cli1.Pass();
     Case pop3Pass:    Pop3Cli1.Stat();
     Case pop3Quit:    ; // Nothing
     Case pop3Stat:
           Begin
             If (ListAll) Then Begin
               Pop3Cli1.MsgNum := 0;
               Pop3Cli1.List();
             End Else Begin
               Pop3Cli1.MsgNum := 1;
               Pop3Cli1.List();
             End;
           End;
     Case pop3List:      // Do not list if it's in "list" mode
           Begin
               If (NOT ListAll)
                 Memo1.Lines.Add('Message='+ IntToStr(Pop3Cli1.MsgNum) +', Size='+ IntToStr(Pop3Cli1.MsgSize));

               Pop3Cli1.Quit();
           End;
   End;
 End;

End;

//--------------------------------------------------------------------------- Procedure TForm1.Pop3Cli1ListBegin(Sender: TObject) Begin

 Memo1.Lines.Add('List Begin');

End;

//--------------------------------------------------------------------------- Procedure TForm1.Pop3Cli1ListLine(Sender: TObject) Begin

 Memo1.Lines.Add('List line='+ Pop3Cli1.LastResponse);
 Memo1.Lines.Add('Message='+ IntToStr(Pop3Cli1.MsgNum) +', Size='+ IntToStr(Pop3Cli1.MsgSize));

End;

//--------------------------------------------------------------------------- Procedure TForm1.Pop3Cli1ListEnd(Sender: TObject) Begin

 Memo1.Lines.Add('List End');

End; //--------------------------------------------------------------------------- </syntaxhighlight>

C++ Example

For this example to work, drop a Memo, Pop3Cli and Button components on the form. Then, add OnClick event to the button and OnListBegin, OnListLine, OnListEnd and OnRequestDone events to the Pop3Cli component and use the following code.

<syntaxhighlight lang="cpp"> //--------------------------------------------------------------------------- void __fastcall TForm1::Button1Click(TObject *Sender) { // Clear the memo for clean output Memo1->Lines->Clear();

// Fill the following with your actual server details Pop3Cli1->Host = "pop3.yourserver.com"; Pop3Cli1->UserName = "username"; Pop3Cli1->PassWord = "password"; Pop3Cli1->Connect(); } //--------------------------------------------------------------------------- void __fastcall TForm1::Pop3Cli1RequestDone(TObject *Sender, TPop3Request RqType, WORD Error) { // Toggle this to change the behaviour of LIST command from single to list and back bool ListAll = true;

if (Error == 0) {

   if (Pop3Cli1->LastResponse != "") Memo1->Lines->Add(Pop3Cli1->LastResponse);

   switch (RqType) {
       case pop3Connect: Pop3Cli1->User(); break;
       case pop3User:    Pop3Cli1->Pass(); break;
       case pop3Pass:    Pop3Cli1->Stat(); break;
       case pop3Quit:    break;
       case pop3Stat:    if (ListAll) {
                             Pop3Cli1->MsgNum = 0;
                             Pop3Cli1->List();
                             }
                         else {
                             Pop3Cli1->MsgNum = 1;
                             Pop3Cli1->List();
                             }
                         break;
       case pop3List:    // Do not list if it's in "list" mode
                         if (!ListAll) {
                             Memo1->Lines->Add("Message="+IntToStr(Pop3Cli1->MsgNum) + ", Size=" + IntToStr(Pop3Cli1->MsgSize));
                             }
                         Pop3Cli1->Quit();
                         break;
       default:          break;
       }
   }

} //--------------------------------------------------------------------------- void __fastcall TForm1::Pop3Cli1ListBegin(TObject *Sender) { Memo1->Lines->Add("List Begin"); } //--------------------------------------------------------------------------- void __fastcall TForm1::Pop3Cli1ListLine(TObject *Sender) { Memo1->Lines->Add("List line="+Pop3Cli1->LastResponse); Memo1->Lines->Add("Message="+IntToStr(Pop3Cli1->MsgNum) + ", Size=" + IntToStr(Pop3Cli1->MsgSize)); } //--------------------------------------------------------------------------- void __fastcall TForm1::Pop3Cli1ListEnd(TObject *Sender) { Memo1->Lines->Add("List End"); } //--------------------------------------------------------------------------- </syntaxhighlight>