Difference between revisions of "TPop3Cli.List"

From Overbyte
Jump to navigation Jump to search
(Created page with ' Main page -> ICS component reference -> TPop3Cli -> List == Definition == '''procedure''' List; virtual;…')
 
 
(6 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
== Definition ==
 
== Definition ==
  
−
'''procedure''' List; virtual;
+
<syntaxhighlight lang="delphi">
 +
procedure List; virtual;
 +
</syntaxhighlight>
  
 
== Description ==
 
== 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 [[TPop3Cli.MsgNum | MsgNum]] property to 0 before calling this method. To issue it in single mode set [[TPop3Cli.MsgNum | MsgNum]] property to index of the message you want to get LIST for.
+
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 [[TPop3Cli.MsgNum | MsgNum]] property to 0 before calling this method. To issue it in single mode set [[TPop3Cli.MsgNum | MsgNum]] property to index of the message you want to get LIST for.  
  
−
//This will issue List in list mode (triggers OnList events)
+
<syntaxhighlight lang="delphi">
−
Pop3Cli.MsgNum := 0;
+
// This will issue List in list mode (triggers OnList events)
−
Pop3Cli.List;
+
Pop3Cli.MsgNum := 0;
 +
Pop3Cli.List;
 +
</syntaxhighlight>
  
−
//This will issue List in single mode for the message 1 (does not trigger OnList events)
+
<syntaxhighlight lang="delphi">
−
Pop3Cli.MsgNum := 1;
+
// This will issue List in single mode for the message 1 (does not trigger OnList events)
−
Pop3Cli.List;
+
Pop3Cli.MsgNum := 1;
 +
Pop3Cli.List;
 +
</syntaxhighlight>
  
−
If the command is issued in single mode it returns the result from POP3 server in the next [[TPop3Cli.LastResponse | LastResponse]] property. If it is issued in list mode, [[TPop3Cli.LastResponse | LastResponse]] will be empty but it will trigger [[TPop3Cli.OnListBegin | OnListBegin]], [[TPop3Cli.OnListLine | OnListLine]] and [[TPop3Cli.OnListEnd | OnListEnd]] events instead which you can use to appropriately handle the output from the LIST. When the events occur, [[TPop3Cli.MsgNum | MsgNum]] and [[TPop3Cli.MsgSize | MsgSize]] contain the value of the currently listed message.
+
If the command is issued in single mode it returns the result from POP3 server in the next [[TPop3Cli.LastResponse | LastResponse]] property. Also, [[TPop3Cli.MsgSize | MsgSize]] will hold the size of the message in octets (bytes). If it is issued in list mode, [[TPop3Cli.LastResponse | LastResponse]] will be empty but it will trigger [[TPop3Cli.OnListBegin | OnListBegin]], [[TPop3Cli.OnListLine | OnListLine]] and [[TPop3Cli.OnListEnd | OnListEnd]] events instead which you can use to appropriately handle the output from the LIST. When the events occur, [[TPop3Cli.MsgNum | MsgNum]] and [[TPop3Cli.MsgSize | MsgSize]] contain the appropriate values of the currently listed message that the event is generated for.
  
 
== Delphi Example ==
 
== 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 [[TPop3Cli.OnListBegin | OnListBegin]], [[TPop3Cli.OnListLine | OnListLine]], [[TPop3Cli.OnListEnd | OnListEnd]] and [[TPop3Cli.OnRequestDone | 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
 +
            Pop3Connect : Pop3Cli1.User;
 +
            Pop3User    : Pop3Cli1.Pass;
 +
            Pop3Pass    : Pop3Cli1.Stat;
 +
            Pop3Quit    : ; // Nothing
 +
            Pop3Stat:
 +
                begin
 +
                    if ListAll then begin
 +
                        Pop3Cli1.MsgNum := 0;
 +
                        Pop3Cli1.List;
 +
                    end
 +
                    else begin
 +
                        Pop3Cli1.MsgNum := 1;
 +
                        Pop3Cli1.List;
 +
                    end;
 +
                end;
 +
            Pop3List: // Do not list if it's in "list" mode
 +
                begin
 +
                    if not ListAll then
 +
                        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 ==
 
== C++ Example ==
Line 25: Line 110:
 
For this example to work, drop a Memo, Pop3Cli and Button components on the form. Then, add OnClick event to the button and [[TPop3Cli.OnListBegin | OnListBegin]], [[TPop3Cli.OnListLine | OnListLine]], [[TPop3Cli.OnListEnd | OnListEnd]] and [[TPop3Cli.OnRequestDone | OnRequestDone]] events to the Pop3Cli component and use the following code.
 
For this example to work, drop a Memo, Pop3Cli and Button components on the form. Then, add OnClick event to the button and [[TPop3Cli.OnListBegin | OnListBegin]], [[TPop3Cli.OnListLine | OnListLine]], [[TPop3Cli.OnListEnd | OnListEnd]] and [[TPop3Cli.OnRequestDone | OnRequestDone]] events to the Pop3Cli component and use the following code.
  
−
//---------------------------------------------------------------------------
+
<syntaxhighlight lang="cpp">
−
'''void __fastcall''' TForm1::Button1Click(TObject *Sender)
+
//---------------------------------------------------------------------------
−
{
+
void __fastcall TForm1::Button1Click(TObject *Sender)
−
// Clear the memo for clean output
+
{
−
Memo1->Lines->Clear();
+
// Clear the memo for clean output
−
+
Memo1->Lines->Clear();
−
Pop3Cli1->Host   = "pop3.host.com";
+
 
−
Pop3Cli1->UserName = "username";
+
// Fill the following with your actual server details
−
Pop3Cli1->PassWord = "password";
+
Pop3Cli1->Host     = "pop3.yourserver.com";
−
Pop3Cli1->Connect();
+
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
+
void __fastcall TForm1::Pop3Cli1RequestDone(TObject *Sender, TPop3Request RqType, WORD Error)
−
'''bool''' ListAll = '''true''';
+
{
−
+
// Toggle this to change the behaviour of LIST command from single to list and back
−
'''if''' (Error == 0)
+
bool ListAll = true;
−
{
+
 
−
'''if''' (Pop3Cli1->LastResponse != "") Memo1->Lines->Add(Pop3Cli1->LastResponse);
+
if (Error == 0) {
−
+
    if (Pop3Cli1->LastResponse != "") Memo1->Lines->Add(Pop3Cli1->LastResponse);
−
'''switch''' (RqType)
+
 
−
{
+
    switch (RqType) {
−
'''case''' pop3Connect: Pop3Cli1->User(); '''break''';
+
        case pop3Connect: Pop3Cli1->User(); break;
−
'''case''' pop3User: Pop3Cli1->Pass(); '''break''';
+
        case pop3User:   Pop3Cli1->Pass(); break;
−
'''case''' pop3Pass: Pop3Cli1->Stat(); '''break''';
+
        case pop3Pass:   Pop3Cli1->Stat(); break;
−
'''case''' pop3Quit: '''break''';
+
        case pop3Quit:   break;
−
'''case''' pop3Stat:   '''if''' (ListAll)
+
        case pop3Stat:   if (ListAll) {
−
{
+
                              Pop3Cli1->MsgNum = 0;
−
Pop3Cli1->MsgNum = 0;
+
                              Pop3Cli1->List();
−
Pop3Cli1->List();
+
                              }
−
}
+
                          else {
−
'''else'''
+
                              Pop3Cli1->MsgNum = 1;
−
                            {
+
                              Pop3Cli1->List();
−
                                Pop3Cli1->MsgNum = 1;
+
                              }
−
Pop3Cli1->List();
+
                          break;
−
}
+
        case pop3List:   // Do not list if it's in "list" mode
−
'''break''';
+
                          if (!ListAll) {
−
'''case''' pop3List: Memo1->Lines->Add("Message="+IntToStr(Pop3Cli1->MsgNum));
+
                              Memo1->Lines->Add("Message="+IntToStr(Pop3Cli1->MsgNum) + ", Size=" + IntToStr(Pop3Cli1->MsgSize));
−
Memo1->Lines->Add("Message size="+IntToStr(Pop3Cli1->MsgSize));
+
                              }
−
Pop3Cli1->Quit();
+
                          Pop3Cli1->Quit();
−
'''break''';
+
                          break;
−
'''default''': '''break''';
+
        default:         break;
−
}
+
        }
−
}
+
    }
−
}
+
}
−
//---------------------------------------------------------------------------
+
//---------------------------------------------------------------------------
−
'''void __fastcall''' TForm1::Pop3Cli1ListBegin(TObject *Sender)
+
void __fastcall TForm1::Pop3Cli1ListBegin(TObject *Sender)
−
{
+
{
−
Memo1->Lines->Add("List Begin");
+
Memo1->Lines->Add("List Begin");
−
}
+
}
−
//---------------------------------------------------------------------------
+
//---------------------------------------------------------------------------
−
'''void __fastcall''' TForm1::Pop3Cli1ListLine(TObject *Sender)
+
void __fastcall TForm1::Pop3Cli1ListLine(TObject *Sender)
−
{
+
{
−
Memo1->Lines->Add("List line="+Pop3Cli1->LastResponse);
+
Memo1->Lines->Add("List line="+Pop3Cli1->LastResponse);
−
Memo1->Lines->Add("Message="+IntToStr(Pop3Cli1->MsgNum));
+
Memo1->Lines->Add("Message="+IntToStr(Pop3Cli1->MsgNum) + ", Size=" + IntToStr(Pop3Cli1->MsgSize));
−
Memo1->Lines->Add("Message size="+IntToStr(Pop3Cli1->MsgSize));
+
}
−
}
+
//---------------------------------------------------------------------------
−
//---------------------------------------------------------------------------
+
void __fastcall TForm1::Pop3Cli1ListEnd(TObject *Sender)
−
'''void __fastcall''' TForm1::Pop3Cli1ListEnd(TObject *Sender)
+
{
−
{
+
Memo1->Lines->Add("List End");
−
Memo1->Lines->Add("List End");
+
}
−
}
+
//---------------------------------------------------------------------------
 +
</syntaxhighlight>
  
 
== Best practices ==
 
== Best practices ==
  
 
== How to ==
 
== How to ==

Latest revision as of 06:42, 1 July 2010

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
           Pop3Connect : Pop3Cli1.User;
           Pop3User    : Pop3Cli1.Pass;
           Pop3Pass    : Pop3Cli1.Stat;
           Pop3Quit    : ; // Nothing
           Pop3Stat:
               begin
                   if ListAll then begin
                       Pop3Cli1.MsgNum := 0;
                       Pop3Cli1.List;
                   end
                   else begin
                       Pop3Cli1.MsgNum := 1;
                       Pop3Cli1.List;
                   end;
               end;
           Pop3List: // Do not list if it's in "list" mode
               begin
                   if not ListAll then
                       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>

Best practices

How to

Retrieved from "http://wiki.overbyte.eu/wiki/index.php?title=TPop3Cli.List&oldid=2454"