source: trunk/Packages/synapse/docs/help/pop3send.TPOP3Send.html

Last change on this file was 2, checked in by chronos, 12 years ago
  • Přidáno: Základní kostra projektu.
  • Přidáno: Knihovna synapse.
File size: 20.9 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
2<html>
3<head>
4<meta name="GENERATOR" content="PasDoc 0.9.0">
5<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
6<title>pop3send: Class TPOP3Send</title>
7<link rel="StyleSheet" type="text/css" href="pasdoc.css">
8</head>
9<body bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#800080" alink="#FF0000">
10<a name="TPOP3Send"></a><h1 class="cio">Class TPOP3Send</h1>
11<table class="sections">
12<tr>
13<td><a class="section" href="#@Description">Description</a></td><td><a class="section" href="#@Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#@Methods">Methods</a></td><td><a class="section" href="#@Properties">Properties</a></td></tr></table>
14<a name="@Description"></a><h2 class="unit">Unit</h2>
15<p class="unitlink">
16<a href="pop3send.html">pop3send</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type TPOP3Send = class(<a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Implementation of POP3 client protocol.</p>
23<p>
24
25
26<p>Note: Are you missing properties for setting Username and Password? Look to parent <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a> object!
27
28<p>Are you missing properties for specify server address and port? Look to parent <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a> too!</p>
29<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
30<ul class="hierarchy"><li class="ancestor">TObject</li>
31<li class="ancestor"><a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a></li>
32<li class="thisitem">TPOP3Send</li></ul><h2 class="overview">Overview</h2>
33<a name="@Methods"></a><h3 class="summary">Methods</h3>
34<table class="summary">
35<tr class="list">
36<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
37<td class="itemcode"><code>constructor <b><a href="pop3send.TPOP3Send.html#Create">Create</a></b>;</code></td>
38</tr>
39<tr class="list2">
40<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
41<td class="itemcode"><code>destructor <b><a href="pop3send.TPOP3Send.html#Destroy">Destroy</a></b>; override;</code></td>
42</tr>
43<tr class="list">
44<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
45<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#CustomCommand">CustomCommand</a></b>(const Command: string; MultiLine: Boolean): boolean;</code></td>
46</tr>
47<tr class="list2">
48<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
49<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Capability">Capability</a></b>: Boolean;</code></td>
50</tr>
51<tr class="list">
52<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
53<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Login">Login</a></b>: Boolean;</code></td>
54</tr>
55<tr class="list2">
56<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
57<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Logout">Logout</a></b>: Boolean;</code></td>
58</tr>
59<tr class="list">
60<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
61<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Reset">Reset</a></b>: Boolean;</code></td>
62</tr>
63<tr class="list2">
64<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
65<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#NoOp">NoOp</a></b>: Boolean;</code></td>
66</tr>
67<tr class="list">
68<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
69<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Stat">Stat</a></b>: Boolean;</code></td>
70</tr>
71<tr class="list2">
72<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
73<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#List">List</a></b>(Value: Integer): Boolean;</code></td>
74</tr>
75<tr class="list">
76<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
77<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Retr">Retr</a></b>(Value: Integer): Boolean;</code></td>
78</tr>
79<tr class="list2">
80<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
81<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#RetrStream">RetrStream</a></b>(Value: Integer; Stream: TStream): Boolean;</code></td>
82</tr>
83<tr class="list">
84<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
85<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Dele">Dele</a></b>(Value: Integer): Boolean;</code></td>
86</tr>
87<tr class="list2">
88<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
89<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Top">Top</a></b>(Value, Maxlines: Integer): Boolean;</code></td>
90</tr>
91<tr class="list">
92<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
93<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#Uidl">Uidl</a></b>(Value: Integer): Boolean;</code></td>
94</tr>
95<tr class="list2">
96<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
97<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#StartTLS">StartTLS</a></b>: Boolean;</code></td>
98</tr>
99<tr class="list">
100<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
101<td class="itemcode"><code>function <b><a href="pop3send.TPOP3Send.html#FindCap">FindCap</a></b>(const Value: string): string;</code></td>
102</tr>
103</table>
104<a name="@Properties"></a><h3 class="summary">Properties</h3>
105<table class="summary">
106<tr class="list">
107<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
108<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#ResultCode">ResultCode</a></b>: Integer read FResultCode;</code></td>
109</tr>
110<tr class="list2">
111<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
112<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#ResultString">ResultString</a></b>: string read FResultString;</code></td>
113</tr>
114<tr class="list">
115<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
116<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#FullResult">FullResult</a></b>: TStringList read FFullResult;</code></td>
117</tr>
118<tr class="list2">
119<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
120<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#StatCount">StatCount</a></b>: Integer read FStatCount;</code></td>
121</tr>
122<tr class="list">
123<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
124<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#StatSize">StatSize</a></b>: Integer read FStatSize;</code></td>
125</tr>
126<tr class="list2">
127<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
128<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#ListSize">ListSize</a></b>: Integer read FListSize;</code></td>
129</tr>
130<tr class="list">
131<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
132<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#TimeStamp">TimeStamp</a></b>: string read FTimeStamp;</code></td>
133</tr>
134<tr class="list2">
135<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
136<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#AuthType">AuthType</a></b>: <a href="pop3send.html#TPOP3AuthType">TPOP3AuthType</a> read FAuthType Write FAuthType;</code></td>
137</tr>
138<tr class="list">
139<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
140<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#AutoTLS">AutoTLS</a></b>: Boolean read FAutoTLS Write FAutoTLS;</code></td>
141</tr>
142<tr class="list2">
143<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
144<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#FullSSL">FullSSL</a></b>: Boolean read FFullSSL Write FFullSSL;</code></td>
145</tr>
146<tr class="list">
147<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
148<td class="itemcode"><code>property <b><a href="pop3send.TPOP3Send.html#Sock">Sock</a></b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
149</tr>
150</table>
151<h2 class="description">Description</h2>
152<h3 class="detail">Methods</h3>
153<table class="detail">
154<tr class="list">
155<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
156<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
157</tr>
158</table>
159&nbsp;<table class="detail">
160<tr class="list">
161<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
162<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
163</tr>
164</table>
165&nbsp;<table class="detail">
166<tr class="list">
167<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
168<td class="itemcode"><a name="CustomCommand"></a><code>function <b>CustomCommand</b>(const Command: string; MultiLine: Boolean): boolean;</code></td>
169</tr>
170</table>
171<p>
172You can call any custom by this method. Call Command without trailing CRLF. If MultiLine parameter is <code>True</code>, multilined response are expected. Result is <code>True</code> on sucess.</p>
173<table class="detail">
174<tr class="list">
175<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
176<td class="itemcode"><a name="Capability"></a><code>function <b>Capability</b>: Boolean;</code></td>
177</tr>
178</table>
179<p>
180Call CAPA command for get POP3 server capabilites. note: not all servers support this command!</p>
181<table class="detail">
182<tr class="list">
183<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
184<td class="itemcode"><a name="Login"></a><code>function <b>Login</b>: Boolean;</code></td>
185</tr>
186</table>
187<p>
188Connect to remote POP3 host. If all OK, result is <code>True</code>.</p>
189<table class="detail">
190<tr class="list">
191<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
192<td class="itemcode"><a name="Logout"></a><code>function <b>Logout</b>: Boolean;</code></td>
193</tr>
194</table>
195<p>
196Disconnects from POP3 server.</p>
197<table class="detail">
198<tr class="list">
199<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
200<td class="itemcode"><a name="Reset"></a><code>function <b>Reset</b>: Boolean;</code></td>
201</tr>
202</table>
203<p>
204Send RSET command. If all OK, result is <code>True</code>.</p>
205<table class="detail">
206<tr class="list">
207<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
208<td class="itemcode"><a name="NoOp"></a><code>function <b>NoOp</b>: Boolean;</code></td>
209</tr>
210</table>
211<p>
212Send NOOP command. If all OK, result is <code>True</code>.</p>
213<table class="detail">
214<tr class="list">
215<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
216<td class="itemcode"><a name="Stat"></a><code>function <b>Stat</b>: Boolean;</code></td>
217</tr>
218</table>
219<p>
220Send STAT command and fill <a class="normal" href="pop3send.TPOP3Send.html#StatCount">StatCount</a> and <a class="normal" href="pop3send.TPOP3Send.html#StatSize">StatSize</a> property. If all OK, result is <code>True</code>.</p>
221<table class="detail">
222<tr class="list">
223<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
224<td class="itemcode"><a name="List"></a><code>function <b>List</b>(Value: Integer): Boolean;</code></td>
225</tr>
226</table>
227<p>
228Send LIST command. If Value is 0, LIST is for all messages. After successful operation is listing in FullResult. If all OK, result is <code>True</code>.</p>
229<table class="detail">
230<tr class="list">
231<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
232<td class="itemcode"><a name="Retr"></a><code>function <b>Retr</b>(Value: Integer): Boolean;</code></td>
233</tr>
234</table>
235<p>
236Send RETR command. After successful operation dowloaded message in <a class="normal" href="pop3send.TPOP3Send.html#FullResult">FullResult</a>. If all OK, result is <code>True</code>.</p>
237<table class="detail">
238<tr class="list">
239<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
240<td class="itemcode"><a name="RetrStream"></a><code>function <b>RetrStream</b>(Value: Integer; Stream: TStream): Boolean;</code></td>
241</tr>
242</table>
243<p>
244Send RETR command. After successful operation dowloaded message in <code>Stream</code>. If all OK, result is <code>True</code>.</p>
245<table class="detail">
246<tr class="list">
247<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
248<td class="itemcode"><a name="Dele"></a><code>function <b>Dele</b>(Value: Integer): Boolean;</code></td>
249</tr>
250</table>
251<p>
252Send DELE command for delete specified message. If all OK, result is <code>True</code>.</p>
253<table class="detail">
254<tr class="list">
255<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
256<td class="itemcode"><a name="Top"></a><code>function <b>Top</b>(Value, Maxlines: Integer): Boolean;</code></td>
257</tr>
258</table>
259<p>
260Send TOP command. After successful operation dowloaded headers of message and maxlines count of message in <a class="normal" href="pop3send.TPOP3Send.html#FullResult">FullResult</a>. If all OK, result is <code>True</code>.</p>
261<table class="detail">
262<tr class="list">
263<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
264<td class="itemcode"><a name="Uidl"></a><code>function <b>Uidl</b>(Value: Integer): Boolean;</code></td>
265</tr>
266</table>
267<p>
268Send UIDL command. If Value is 0, UIDL is for all messages. After successful operation is listing in FullResult. If all OK, result is <code>True</code>.</p>
269<table class="detail">
270<tr class="list">
271<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
272<td class="itemcode"><a name="StartTLS"></a><code>function <b>StartTLS</b>: Boolean;</code></td>
273</tr>
274</table>
275<p>
276Call STLS command for upgrade connection to SSL/TLS mode.</p>
277<table class="detail">
278<tr class="list">
279<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
280<td class="itemcode"><a name="FindCap"></a><code>function <b>FindCap</b>(const Value: string): string;</code></td>
281</tr>
282</table>
283<p>
284Try to find given capabily in capabilty string returned from POP3 server by CAPA command.</p>
285<h3 class="detail">Properties</h3>
286<table class="detail">
287<tr class="list">
288<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
289<td class="itemcode"><a name="ResultCode"></a><code>property <b>ResultCode</b>: Integer read FResultCode;</code></td>
290</tr>
291</table>
292<p>
293Result code of last POP3 operation. 0 - error, 1 - OK.</p>
294<table class="detail">
295<tr class="list">
296<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
297<td class="itemcode"><a name="ResultString"></a><code>property <b>ResultString</b>: string read FResultString;</code></td>
298</tr>
299</table>
300<p>
301Result string of last POP3 operation.</p>
302<table class="detail">
303<tr class="list">
304<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
305<td class="itemcode"><a name="FullResult"></a><code>property <b>FullResult</b>: TStringList read FFullResult;</code></td>
306</tr>
307</table>
308<p>
309Stringlist with full lines returned as result of POP3 operation. I.e. if operation is LIST, this property is filled by list of messages. If operation is RETR, this property have downloaded message.</p>
310<table class="detail">
311<tr class="list">
312<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
313<td class="itemcode"><a name="StatCount"></a><code>property <b>StatCount</b>: Integer read FStatCount;</code></td>
314</tr>
315</table>
316<p>
317After STAT command is there count of messages in inbox.</p>
318<table class="detail">
319<tr class="list">
320<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
321<td class="itemcode"><a name="StatSize"></a><code>property <b>StatSize</b>: Integer read FStatSize;</code></td>
322</tr>
323</table>
324<p>
325After STAT command is there size of all messages in inbox.</p>
326<table class="detail">
327<tr class="list">
328<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
329<td class="itemcode"><a name="ListSize"></a><code>property <b>ListSize</b>: Integer read FListSize;</code></td>
330</tr>
331</table>
332<p>
333After LIST 0 command size of all messages on server, After LIST x size of message x on server</p>
334<table class="detail">
335<tr class="list">
336<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
337<td class="itemcode"><a name="TimeStamp"></a><code>property <b>TimeStamp</b>: string read FTimeStamp;</code></td>
338</tr>
339</table>
340<p>
341If server support this, after comnnect is in this property timestamp of remote server.</p>
342<table class="detail">
343<tr class="list">
344<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
345<td class="itemcode"><a name="AuthType"></a><code>property <b>AuthType</b>: <a href="pop3send.html#TPOP3AuthType">TPOP3AuthType</a> read FAuthType Write FAuthType;</code></td>
346</tr>
347</table>
348<p>
349Type of authorisation for login to POP3 server. Dafault is autodetect one of possible authorisation. Autodetect do this:
350
351<p>If remote POP3 server support APOP, try login by APOP method. If APOP is not supported, or if APOP login failed, try classic USER+PASS login method.</p>
352<table class="detail">
353<tr class="list">
354<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
355<td class="itemcode"><a name="AutoTLS"></a><code>property <b>AutoTLS</b>: Boolean read FAutoTLS Write FAutoTLS;</code></td>
356</tr>
357</table>
358<p>
359If is set to <code>True</code>, then upgrade to SSL/TLS mode if remote server support it.</p>
360<table class="detail">
361<tr class="list">
362<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
363<td class="itemcode"><a name="FullSSL"></a><code>property <b>FullSSL</b>: Boolean read FFullSSL Write FFullSSL;</code></td>
364</tr>
365</table>
366<p>
367SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port!</p>
368<table class="detail">
369<tr class="list">
370<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
371<td class="itemcode"><a name="Sock"></a><code>property <b>Sock</b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
372</tr>
373</table>
374<p>
375Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.</p>
376<hr noshade size="1"><span class="appinfo"><em>Generated by <a target="_parent" href="http://pasdoc.sourceforge.net/">PasDoc 0.9.0</a> on 2012-04-23 21:38:51</em>
377</span>
378</body></html>
Note: See TracBrowser for help on using the repository browser.