TPOP3Client - Revision history

Ultibo: Created page with "Return to Unit POP3 TOC === Description === ---- ''To be documented'' === Class definitions === ----

2018-05-25T01:41:41Z

Created page with "Return to Unit POP3 TOC === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible mw-collapse..."

New page
Return to [[Unit_POP3|Unit POP3]]

TOC

=== Description ===
----

''To be documented''

=== Class definitions ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TPOP3Client = class(TWinsock2TCPClient)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>constructor Create;</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FOnRequest:TPOP3ClientNotifyEvent;</code>
|  
|-
| <code>FOnReply:TPOP3ClientNotifyEvent;</code>
|  
|-
|colspan="2"| 
|-
| <code>FOnRequestStart:TNotifyEvent;</code>
|  
|-
| <code>FOnRequestEnd:TNotifyEvent;</code>
|  
|-
|colspan="2"| 
|-
| <code>FBuffer:TPOP3Buffer;</code>
| Buffer for received data
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>function GetReply(var AReply:String):Boolean;</code>
|  
|-
| <code>function SendRequest(const ARequest:String):Boolean;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property OnRequest:TPOP3ClientNotifyEvent read FOnRequest write FOnRequest;</code>
|  
|-
| <code>property OnReply:TPOP3ClientNotifyEvent read FOnReply write FOnReply;</code>
|  
|-
|colspan="2"| 
|-
| <code>property OnRequestStart:TNotifyEvent read FOnRequestStart write FOnRequestStart;</code>
|  
|-
| <code>property OnRequestEnd:TNotifyEvent read FOnRequestEnd write FOnRequestEnd;</code>
|  
|-
|colspan="2"| 
|-
| <code>property Buffer:TPOP3Buffer read FBuffer;</code>
|  
|-
|colspan="2"| 
|-
| <code>function DoConn(const AHost,APort:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoStat(var AReply:String):Boolean;</code>
|  
|-
| <code>function DoList(const AMessage:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoRetr(const AMessage:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoDele(const AMessage:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoNoop(var AReply:String):Boolean;</code>
|  
|-
| <code>function DoRset(var AReply:String):Boolean;</code>
|  
|-
| <code>function DoQuit(var AReply:String):Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function DoTop(const AMessage,ACount:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoUidl(const AMessage:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoUser(const AUsername:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoPass(const APassword:String; var AReply:String):Boolean;</code>
|  
|-
| <code>function DoApop(const AUsername,ADigest:String; var AReply:String):Boolean;</code>
|  
|-
|}
</div></div>
<br />

=== Function declarations ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">constructor TPOP3Client.Create;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">destructor TPOP3Client.Destroy;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.GetReply(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.SendRequest(const ARequest:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoConn(const AHost,APort:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' POP3 server will return +OK for success and -ERR for failure</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoStat(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' POP3 server will return +OK for success and -ERR for failure</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| None documented
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoList(const AMessage:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoRetr(const AMessage:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoDele(const AMessage:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoNoop(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoRset(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoQuit(var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoTop(const AMessage,ACount:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoUidl(const AMessage:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoUser(const AUsername:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoPass(const APassword:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
<pre style="border: 0; padding-bottom:0px;">function TPOP3Client.DoApop(const AUsername,ADigest:String; var AReply:String):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| POP3 server will return +OK for success and -ERR for failure
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]