source: trunk/Packages/synapse/docs/help/imapsend.TIMAPSend.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: 34.5 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>imapsend: Class TIMAPSend</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="TIMAPSend"></a><h1 class="cio">Class TIMAPSend</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="imapsend.html">imapsend</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type TIMAPSend = class(<a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Implementation of IMAP4 protocol.</p>
23<p>
24 Note: Are you missing properties for setting Username and Password? Look to parent <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a> object!
25
26<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>
27<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
28<ul class="hierarchy"><li class="ancestor">TObject</li>
29<li class="ancestor"><a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a></li>
30<li class="thisitem">TIMAPSend</li></ul><h2 class="overview">Overview</h2>
31<a name="@Methods"></a><h3 class="summary">Methods</h3>
32<table class="summary">
33<tr class="list">
34<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
35<td class="itemcode"><code>constructor <b><a href="imapsend.TIMAPSend.html#Create">Create</a></b>;</code></td>
36</tr>
37<tr class="list2">
38<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
39<td class="itemcode"><code>destructor <b><a href="imapsend.TIMAPSend.html#Destroy">Destroy</a></b>; override;</code></td>
40</tr>
41<tr class="list">
42<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
43<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#IMAPcommand">IMAPcommand</a></b>(Value: string): string;</code></td>
44</tr>
45<tr class="list2">
46<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
47<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#IMAPuploadCommand">IMAPuploadCommand</a></b>(Value: string; const Data:TStrings): string;</code></td>
48</tr>
49<tr class="list">
50<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
51<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#Capability">Capability</a></b>: Boolean;</code></td>
52</tr>
53<tr class="list2">
54<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
55<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#Login">Login</a></b>: Boolean;</code></td>
56</tr>
57<tr class="list">
58<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
59<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#Logout">Logout</a></b>: Boolean;</code></td>
60</tr>
61<tr class="list2">
62<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
63<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#NoOp">NoOp</a></b>: Boolean;</code></td>
64</tr>
65<tr class="list">
66<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
67<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#List">List</a></b>(FromFolder: string; const FolderList: TStrings): Boolean;</code></td>
68</tr>
69<tr class="list2">
70<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
71<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#ListSearch">ListSearch</a></b>(FromFolder, Search: string; const FolderList: TStrings): Boolean;</code></td>
72</tr>
73<tr class="list">
74<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
75<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#ListSubscribed">ListSubscribed</a></b>(FromFolder: string; const FolderList: TStrings): Boolean;</code></td>
76</tr>
77<tr class="list2">
78<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
79<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#ListSearchSubscribed">ListSearchSubscribed</a></b>(FromFolder, Search: string; const FolderList: TStrings): Boolean;</code></td>
80</tr>
81<tr class="list">
82<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
83<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#CreateFolder">CreateFolder</a></b>(FolderName: string): Boolean;</code></td>
84</tr>
85<tr class="list2">
86<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
87<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#DeleteFolder">DeleteFolder</a></b>(FolderName: string): Boolean;</code></td>
88</tr>
89<tr class="list">
90<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
91<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#RenameFolder">RenameFolder</a></b>(FolderName, NewFolderName: string): Boolean;</code></td>
92</tr>
93<tr class="list2">
94<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
95<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#SubscribeFolder">SubscribeFolder</a></b>(FolderName: string): Boolean;</code></td>
96</tr>
97<tr class="list">
98<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
99<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#UnsubscribeFolder">UnsubscribeFolder</a></b>(FolderName: string): Boolean;</code></td>
100</tr>
101<tr class="list2">
102<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
103<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#SelectFolder">SelectFolder</a></b>(FolderName: string): Boolean;</code></td>
104</tr>
105<tr class="list">
106<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
107<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#SelectROFolder">SelectROFolder</a></b>(FolderName: string): Boolean;</code></td>
108</tr>
109<tr class="list2">
110<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
111<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#CloseFolder">CloseFolder</a></b>: Boolean;</code></td>
112</tr>
113<tr class="list">
114<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
115<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#StatusFolder">StatusFolder</a></b>(FolderName, Value: string): integer;</code></td>
116</tr>
117<tr class="list2">
118<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
119<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#ExpungeFolder">ExpungeFolder</a></b>: Boolean;</code></td>
120</tr>
121<tr class="list">
122<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
123<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#CheckFolder">CheckFolder</a></b>: Boolean;</code></td>
124</tr>
125<tr class="list2">
126<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
127<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#AppendMess">AppendMess</a></b>(ToFolder: string; const Mess: TStrings): Boolean;</code></td>
128</tr>
129<tr class="list">
130<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
131<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#DeleteMess">DeleteMess</a></b>(MessID: integer): boolean;</code></td>
132</tr>
133<tr class="list2">
134<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
135<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#FetchMess">FetchMess</a></b>(MessID: integer; const Mess: TStrings): Boolean;</code></td>
136</tr>
137<tr class="list">
138<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
139<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#FetchHeader">FetchHeader</a></b>(MessID: integer; const Headers: TStrings): Boolean;</code></td>
140</tr>
141<tr class="list2">
142<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
143<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#MessageSize">MessageSize</a></b>(MessID: integer): integer;</code></td>
144</tr>
145<tr class="list">
146<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
147<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#CopyMess">CopyMess</a></b>(MessID: integer; ToFolder: string): Boolean;</code></td>
148</tr>
149<tr class="list2">
150<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
151<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#SearchMess">SearchMess</a></b>(Criteria: string; const FoundMess: TStrings): Boolean;</code></td>
152</tr>
153<tr class="list">
154<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
155<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#SetFlagsMess">SetFlagsMess</a></b>(MessID: integer; Flags: string): Boolean;</code></td>
156</tr>
157<tr class="list2">
158<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
159<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#GetFlagsMess">GetFlagsMess</a></b>(MessID: integer; var Flags: string): Boolean;</code></td>
160</tr>
161<tr class="list">
162<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
163<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#AddFlagsMess">AddFlagsMess</a></b>(MessID: integer; Flags: string): Boolean;</code></td>
164</tr>
165<tr class="list2">
166<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
167<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#DelFlagsMess">DelFlagsMess</a></b>(MessID: integer; Flags: string): Boolean;</code></td>
168</tr>
169<tr class="list">
170<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
171<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#StartTLS">StartTLS</a></b>: Boolean;</code></td>
172</tr>
173<tr class="list2">
174<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
175<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#GetUID">GetUID</a></b>(MessID: integer; var UID : Integer): Boolean;</code></td>
176</tr>
177<tr class="list">
178<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
179<td class="itemcode"><code>function <b><a href="imapsend.TIMAPSend.html#FindCap">FindCap</a></b>(const Value: string): string;</code></td>
180</tr>
181</table>
182<a name="@Properties"></a><h3 class="summary">Properties</h3>
183<table class="summary">
184<tr class="list">
185<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
186<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#ResultString">ResultString</a></b>: string read FResultString;</code></td>
187</tr>
188<tr class="list2">
189<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
190<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#FullResult">FullResult</a></b>: TStringList read FFullResult;</code></td>
191</tr>
192<tr class="list">
193<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
194<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#IMAPcap">IMAPcap</a></b>: TStringList read FIMAPcap;</code></td>
195</tr>
196<tr class="list2">
197<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
198<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#AuthDone">AuthDone</a></b>: Boolean read FAuthDone;</code></td>
199</tr>
200<tr class="list">
201<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
202<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#UID">UID</a></b>: Boolean read FUID Write FUID;</code></td>
203</tr>
204<tr class="list2">
205<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
206<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#SelectedFolder">SelectedFolder</a></b>: string read FSelectedFolder;</code></td>
207</tr>
208<tr class="list">
209<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
210<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#SelectedCount">SelectedCount</a></b>: integer read FSelectedCount;</code></td>
211</tr>
212<tr class="list2">
213<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
214<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#SelectedRecent">SelectedRecent</a></b>: integer read FSelectedRecent;</code></td>
215</tr>
216<tr class="list">
217<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
218<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#SelectedUIDvalidity">SelectedUIDvalidity</a></b>: integer read FSelectedUIDvalidity;</code></td>
219</tr>
220<tr class="list2">
221<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
222<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#AutoTLS">AutoTLS</a></b>: Boolean read FAutoTLS Write FAutoTLS;</code></td>
223</tr>
224<tr class="list">
225<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
226<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#FullSSL">FullSSL</a></b>: Boolean read FFullSSL Write FFullSSL;</code></td>
227</tr>
228<tr class="list2">
229<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
230<td class="itemcode"><code>property <b><a href="imapsend.TIMAPSend.html#Sock">Sock</a></b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
231</tr>
232</table>
233<h2 class="description">Description</h2>
234<h3 class="detail">Methods</h3>
235<table class="detail">
236<tr class="list">
237<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
238<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
239</tr>
240</table>
241&nbsp;<table class="detail">
242<tr class="list">
243<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
244<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
245</tr>
246</table>
247&nbsp;<table class="detail">
248<tr class="list">
249<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
250<td class="itemcode"><a name="IMAPcommand"></a><code>function <b>IMAPcommand</b>(Value: string): string;</code></td>
251</tr>
252</table>
253<p>
254By this function you can call any IMAP command. Result of this command is in adequate properties.</p>
255<table class="detail">
256<tr class="list">
257<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
258<td class="itemcode"><a name="IMAPuploadCommand"></a><code>function <b>IMAPuploadCommand</b>(Value: string; const Data:TStrings): string;</code></td>
259</tr>
260</table>
261<p>
262By this function you can call any IMAP command what need upload any data. Result of this command is in adequate properties.</p>
263<table class="detail">
264<tr class="list">
265<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
266<td class="itemcode"><a name="Capability"></a><code>function <b>Capability</b>: Boolean;</code></td>
267</tr>
268</table>
269<p>
270Call CAPABILITY command and fill IMAPcap property by new values.</p>
271<table class="detail">
272<tr class="list">
273<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
274<td class="itemcode"><a name="Login"></a><code>function <b>Login</b>: Boolean;</code></td>
275</tr>
276</table>
277<p>
278Connect to IMAP server and do login to this server. This command begin session.</p>
279<table class="detail">
280<tr class="list">
281<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
282<td class="itemcode"><a name="Logout"></a><code>function <b>Logout</b>: Boolean;</code></td>
283</tr>
284</table>
285<p>
286Disconnect from IMAP server and terminate session session. If exists some deleted and non-purged messages, these messages are not deleted!</p>
287<table class="detail">
288<tr class="list">
289<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
290<td class="itemcode"><a name="NoOp"></a><code>function <b>NoOp</b>: Boolean;</code></td>
291</tr>
292</table>
293<p>
294Do NOOP. It is for prevent disconnect by timeout.</p>
295<table class="detail">
296<tr class="list">
297<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
298<td class="itemcode"><a name="List"></a><code>function <b>List</b>(FromFolder: string; const FolderList: TStrings): Boolean;</code></td>
299</tr>
300</table>
301<p>
302Lists folder names. You may specify level of listing. If you specify FromFolder as empty string, return is all folders in system.</p>
303<table class="detail">
304<tr class="list">
305<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
306<td class="itemcode"><a name="ListSearch"></a><code>function <b>ListSearch</b>(FromFolder, Search: string; const FolderList: TStrings): Boolean;</code></td>
307</tr>
308</table>
309<p>
310Lists folder names what match search criteria. You may specify level of listing. If you specify FromFolder as empty string, return is all folders in system.</p>
311<table class="detail">
312<tr class="list">
313<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
314<td class="itemcode"><a name="ListSubscribed"></a><code>function <b>ListSubscribed</b>(FromFolder: string; const FolderList: TStrings): Boolean;</code></td>
315</tr>
316</table>
317<p>
318Lists subscribed folder names. You may specify level of listing. If you specify FromFolder as empty string, return is all subscribed folders in system.</p>
319<table class="detail">
320<tr class="list">
321<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
322<td class="itemcode"><a name="ListSearchSubscribed"></a><code>function <b>ListSearchSubscribed</b>(FromFolder, Search: string; const FolderList: TStrings): Boolean;</code></td>
323</tr>
324</table>
325<p>
326Lists subscribed folder names what matching search criteria. You may specify level of listing. If you specify FromFolder as empty string, return is all subscribed folders in system.</p>
327<table class="detail">
328<tr class="list">
329<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
330<td class="itemcode"><a name="CreateFolder"></a><code>function <b>CreateFolder</b>(FolderName: string): Boolean;</code></td>
331</tr>
332</table>
333<p>
334Create a new folder.</p>
335<table class="detail">
336<tr class="list">
337<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
338<td class="itemcode"><a name="DeleteFolder"></a><code>function <b>DeleteFolder</b>(FolderName: string): Boolean;</code></td>
339</tr>
340</table>
341<p>
342Delete a folder.</p>
343<table class="detail">
344<tr class="list">
345<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
346<td class="itemcode"><a name="RenameFolder"></a><code>function <b>RenameFolder</b>(FolderName, NewFolderName: string): Boolean;</code></td>
347</tr>
348</table>
349<p>
350Rename folder names.</p>
351<table class="detail">
352<tr class="list">
353<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
354<td class="itemcode"><a name="SubscribeFolder"></a><code>function <b>SubscribeFolder</b>(FolderName: string): Boolean;</code></td>
355</tr>
356</table>
357<p>
358Subscribe folder.</p>
359<table class="detail">
360<tr class="list">
361<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
362<td class="itemcode"><a name="UnsubscribeFolder"></a><code>function <b>UnsubscribeFolder</b>(FolderName: string): Boolean;</code></td>
363</tr>
364</table>
365<p>
366Unsubscribe folder.</p>
367<table class="detail">
368<tr class="list">
369<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
370<td class="itemcode"><a name="SelectFolder"></a><code>function <b>SelectFolder</b>(FolderName: string): Boolean;</code></td>
371</tr>
372</table>
373<p>
374Select folder.</p>
375<table class="detail">
376<tr class="list">
377<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
378<td class="itemcode"><a name="SelectROFolder"></a><code>function <b>SelectROFolder</b>(FolderName: string): Boolean;</code></td>
379</tr>
380</table>
381<p>
382Select folder, but only for reading. Any changes are not allowed!</p>
383<table class="detail">
384<tr class="list">
385<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
386<td class="itemcode"><a name="CloseFolder"></a><code>function <b>CloseFolder</b>: Boolean;</code></td>
387</tr>
388</table>
389<p>
390Close a folder. (end of Selected state)</p>
391<table class="detail">
392<tr class="list">
393<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
394<td class="itemcode"><a name="StatusFolder"></a><code>function <b>StatusFolder</b>(FolderName, Value: string): integer;</code></td>
395</tr>
396</table>
397<p>
398Ask for given status of folder. I.e. if you specify as value 'UNSEEN', result is number of unseen messages in folder. For another status indentificator check IMAP documentation and documentation of your IMAP server (each IMAP server can have their own statuses.)</p>
399<table class="detail">
400<tr class="list">
401<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
402<td class="itemcode"><a name="ExpungeFolder"></a><code>function <b>ExpungeFolder</b>: Boolean;</code></td>
403</tr>
404</table>
405<p>
406Hardly delete all messages marked as 'deleted' in current selected folder.</p>
407<table class="detail">
408<tr class="list">
409<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
410<td class="itemcode"><a name="CheckFolder"></a><code>function <b>CheckFolder</b>: Boolean;</code></td>
411</tr>
412</table>
413<p>
414Touch to folder. (use as update status of folder, etc.)</p>
415<table class="detail">
416<tr class="list">
417<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
418<td class="itemcode"><a name="AppendMess"></a><code>function <b>AppendMess</b>(ToFolder: string; const Mess: TStrings): Boolean;</code></td>
419</tr>
420</table>
421<p>
422Append given message to specified folder.</p>
423<table class="detail">
424<tr class="list">
425<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
426<td class="itemcode"><a name="DeleteMess"></a><code>function <b>DeleteMess</b>(MessID: integer): boolean;</code></td>
427</tr>
428</table>
429<p>
430'Delete' message from current selected folder. It mark message as Deleted. Real deleting will be done after sucessfull <a class="normal" href="imapsend.TIMAPSend.html#CloseFolder">CloseFolder</a> or <a class="normal" href="imapsend.TIMAPSend.html#ExpungeFolder">ExpungeFolder</a></p>
431<table class="detail">
432<tr class="list">
433<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
434<td class="itemcode"><a name="FetchMess"></a><code>function <b>FetchMess</b>(MessID: integer; const Mess: TStrings): Boolean;</code></td>
435</tr>
436</table>
437<p>
438Get full message from specified message in selected folder.</p>
439<table class="detail">
440<tr class="list">
441<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
442<td class="itemcode"><a name="FetchHeader"></a><code>function <b>FetchHeader</b>(MessID: integer; const Headers: TStrings): Boolean;</code></td>
443</tr>
444</table>
445<p>
446Get message headers only from specified message in selected folder.</p>
447<table class="detail">
448<tr class="list">
449<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
450<td class="itemcode"><a name="MessageSize"></a><code>function <b>MessageSize</b>(MessID: integer): integer;</code></td>
451</tr>
452</table>
453<p>
454Return message size of specified message from current selected folder.</p>
455<table class="detail">
456<tr class="list">
457<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
458<td class="itemcode"><a name="CopyMess"></a><code>function <b>CopyMess</b>(MessID: integer; ToFolder: string): Boolean;</code></td>
459</tr>
460</table>
461<p>
462Copy message from current selected folder to another folder.</p>
463<table class="detail">
464<tr class="list">
465<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
466<td class="itemcode"><a name="SearchMess"></a><code>function <b>SearchMess</b>(Criteria: string; const FoundMess: TStrings): Boolean;</code></td>
467</tr>
468</table>
469<p>
470Return message numbers from currently selected folder as result of searching. Search criteria is very complex language (see to IMAP specification) similar to SQL (but not same syntax!).</p>
471<table class="detail">
472<tr class="list">
473<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
474<td class="itemcode"><a name="SetFlagsMess"></a><code>function <b>SetFlagsMess</b>(MessID: integer; Flags: string): Boolean;</code></td>
475</tr>
476</table>
477<p>
478Sets flags of message from current selected folder.</p>
479<table class="detail">
480<tr class="list">
481<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
482<td class="itemcode"><a name="GetFlagsMess"></a><code>function <b>GetFlagsMess</b>(MessID: integer; var Flags: string): Boolean;</code></td>
483</tr>
484</table>
485<p>
486Gets flags of message from current selected folder.</p>
487<table class="detail">
488<tr class="list">
489<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
490<td class="itemcode"><a name="AddFlagsMess"></a><code>function <b>AddFlagsMess</b>(MessID: integer; Flags: string): Boolean;</code></td>
491</tr>
492</table>
493<p>
494Add flags to message's flags.</p>
495<table class="detail">
496<tr class="list">
497<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
498<td class="itemcode"><a name="DelFlagsMess"></a><code>function <b>DelFlagsMess</b>(MessID: integer; Flags: string): Boolean;</code></td>
499</tr>
500</table>
501<p>
502Remove flags from message's flags.</p>
503<table class="detail">
504<tr class="list">
505<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
506<td class="itemcode"><a name="StartTLS"></a><code>function <b>StartTLS</b>: Boolean;</code></td>
507</tr>
508</table>
509<p>
510Call STARTTLS command for upgrade connection to SSL/TLS mode.</p>
511<table class="detail">
512<tr class="list">
513<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
514<td class="itemcode"><a name="GetUID"></a><code>function <b>GetUID</b>(MessID: integer; var UID : Integer): Boolean;</code></td>
515</tr>
516</table>
517<p>
518return UID of requested message ID.</p>
519<table class="detail">
520<tr class="list">
521<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
522<td class="itemcode"><a name="FindCap"></a><code>function <b>FindCap</b>(const Value: string): string;</code></td>
523</tr>
524</table>
525<p>
526Try to find given capabily in capabilty string returned from IMAP server.</p>
527<h3 class="detail">Properties</h3>
528<table class="detail">
529<tr class="list">
530<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
531<td class="itemcode"><a name="ResultString"></a><code>property <b>ResultString</b>: string read FResultString;</code></td>
532</tr>
533</table>
534<p>
535Status line with result of last operation.</p>
536<table class="detail">
537<tr class="list">
538<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
539<td class="itemcode"><a name="FullResult"></a><code>property <b>FullResult</b>: TStringList read FFullResult;</code></td>
540</tr>
541</table>
542<p>
543Full result of last IMAP operation.</p>
544<table class="detail">
545<tr class="list">
546<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
547<td class="itemcode"><a name="IMAPcap"></a><code>property <b>IMAPcap</b>: TStringList read FIMAPcap;</code></td>
548</tr>
549</table>
550<p>
551List of server capabilites.</p>
552<table class="detail">
553<tr class="list">
554<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
555<td class="itemcode"><a name="AuthDone"></a><code>property <b>AuthDone</b>: Boolean read FAuthDone;</code></td>
556</tr>
557</table>
558<p>
559Authorization is successful done.</p>
560<table class="detail">
561<tr class="list">
562<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
563<td class="itemcode"><a name="UID"></a><code>property <b>UID</b>: Boolean read FUID Write FUID;</code></td>
564</tr>
565</table>
566<p>
567Turn on or off usage of UID (unicate identificator) of messages instead only sequence numbers.</p>
568<table class="detail">
569<tr class="list">
570<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
571<td class="itemcode"><a name="SelectedFolder"></a><code>property <b>SelectedFolder</b>: string read FSelectedFolder;</code></td>
572</tr>
573</table>
574<p>
575Name of currently selected folder.</p>
576<table class="detail">
577<tr class="list">
578<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
579<td class="itemcode"><a name="SelectedCount"></a><code>property <b>SelectedCount</b>: integer read FSelectedCount;</code></td>
580</tr>
581</table>
582<p>
583Count of messages in currently selected folder.</p>
584<table class="detail">
585<tr class="list">
586<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
587<td class="itemcode"><a name="SelectedRecent"></a><code>property <b>SelectedRecent</b>: integer read FSelectedRecent;</code></td>
588</tr>
589</table>
590<p>
591Count of not-visited messages in currently selected folder.</p>
592<table class="detail">
593<tr class="list">
594<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
595<td class="itemcode"><a name="SelectedUIDvalidity"></a><code>property <b>SelectedUIDvalidity</b>: integer read FSelectedUIDvalidity;</code></td>
596</tr>
597</table>
598<p>
599This number with name of folder is unique indentificator of folder. (If someone delete folder and next create new folder with exactly same name of folder, this number is must be different!)</p>
600<table class="detail">
601<tr class="list">
602<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
603<td class="itemcode"><a name="AutoTLS"></a><code>property <b>AutoTLS</b>: Boolean read FAutoTLS Write FAutoTLS;</code></td>
604</tr>
605</table>
606<p>
607If is set to true, then upgrade to SSL/TLS mode if remote server support it.</p>
608<table class="detail">
609<tr class="list">
610<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
611<td class="itemcode"><a name="FullSSL"></a><code>property <b>FullSSL</b>: Boolean read FFullSSL Write FFullSSL;</code></td>
612</tr>
613</table>
614<p>
615SSL/TLS mode is used from first contact to server. Servers with full SSL/TLS mode usualy using non-standard TCP port!</p>
616<table class="detail">
617<tr class="list">
618<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
619<td class="itemcode"><a name="Sock"></a><code>property <b>Sock</b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
620</tr>
621</table>
622<p>
623Socket object used for TCP/IP operation. Good for seting OnStatus hook, etc.</p>
624<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>
625</span>
626</body></html>
Note: See TracBrowser for help on using the repository browser.