source: trunk/Packages/synapse/docs/help/mimemess.TMessHeader.html

Last change on this file was 2, checked in by chronos, 13 years ago
  • Přidáno: Základní kostra projektu.
  • Přidáno: Knihovna synapse.
File size: 14.2 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>mimemess: Class TMessHeader</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="TMessHeader"></a><h1 class="cio">Class TMessHeader</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="mimemess.html">mimemess</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type TMessHeader = class(TObject)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Object for basic e-mail header fields.</p>
23<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
24<ul class="hierarchy"><li class="ancestor">TObject</li>
25<li class="thisitem">TMessHeader</li></ul><h2 class="overview">Overview</h2>
26<a name="@Methods"></a><h3 class="summary">Methods</h3>
27<table class="summary">
28<tr class="list">
29<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
30<td class="itemcode"><code>constructor <b><a href="mimemess.TMessHeader.html#Create">Create</a></b>; virtual;</code></td>
31</tr>
32<tr class="list2">
33<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
34<td class="itemcode"><code>destructor <b><a href="mimemess.TMessHeader.html#Destroy">Destroy</a></b>; override;</code></td>
35</tr>
36<tr class="list">
37<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
38<td class="itemcode"><code>procedure <b><a href="mimemess.TMessHeader.html#Clear">Clear</a></b>; virtual;</code></td>
39</tr>
40<tr class="list2">
41<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
42<td class="itemcode"><code>procedure <b><a href="mimemess.TMessHeader.html#EncodeHeaders">EncodeHeaders</a></b>(const Value: TStrings); virtual;</code></td>
43</tr>
44<tr class="list">
45<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
46<td class="itemcode"><code>procedure <b><a href="mimemess.TMessHeader.html#DecodeHeaders">DecodeHeaders</a></b>(const Value: TStrings);</code></td>
47</tr>
48<tr class="list2">
49<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
50<td class="itemcode"><code>function <b><a href="mimemess.TMessHeader.html#FindHeader">FindHeader</a></b>(Value: string): string;</code></td>
51</tr>
52<tr class="list">
53<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
54<td class="itemcode"><code>procedure <b><a href="mimemess.TMessHeader.html#FindHeaderList">FindHeaderList</a></b>(Value: string; const HeaderList: TStrings);</code></td>
55</tr>
56</table>
57<a name="@Properties"></a><h3 class="summary">Properties</h3>
58<table class="summary">
59<tr class="list">
60<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
61<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#From">From</a></b>: string read FFrom Write FFrom;</code></td>
62</tr>
63<tr class="list2">
64<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
65<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#ToList">ToList</a></b>: TStringList read FToList;</code></td>
66</tr>
67<tr class="list">
68<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
69<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#CCList">CCList</a></b>: TStringList read FCCList;</code></td>
70</tr>
71<tr class="list2">
72<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
73<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#Subject">Subject</a></b>: string read FSubject Write FSubject;</code></td>
74</tr>
75<tr class="list">
76<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
77<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#Organization">Organization</a></b>: string read FOrganization Write FOrganization;</code></td>
78</tr>
79<tr class="list2">
80<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
81<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#CustomHeaders">CustomHeaders</a></b>: TStringList read FCustomHeaders;</code></td>
82</tr>
83<tr class="list">
84<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
85<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#Date">Date</a></b>: TDateTime read FDate Write FDate;</code></td>
86</tr>
87<tr class="list2">
88<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
89<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#XMailer">XMailer</a></b>: string read FXMailer Write FXMailer;</code></td>
90</tr>
91<tr class="list">
92<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
93<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#ReplyTo">ReplyTo</a></b>: string read FReplyTo Write FReplyTo;</code></td>
94</tr>
95<tr class="list2">
96<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
97<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#MessageID">MessageID</a></b>: string read FMessageID Write FMessageID;</code></td>
98</tr>
99<tr class="list">
100<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
101<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#Priority">Priority</a></b>: <a href="mimemess.html#TMessPriority">TMessPriority</a> read FPriority Write FPriority;</code></td>
102</tr>
103<tr class="list2">
104<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
105<td class="itemcode"><code>property <b><a href="mimemess.TMessHeader.html#CharsetCode">CharsetCode</a></b>: <a href="synachar.html#TMimeChar">TMimeChar</a> read FCharsetCode Write FCharsetCode;</code></td>
106</tr>
107</table>
108<h2 class="description">Description</h2>
109<h3 class="detail">Methods</h3>
110<table class="detail">
111<tr class="list">
112<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
113<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>; virtual;</code></td>
114</tr>
115</table>
116&nbsp;<table class="detail">
117<tr class="list">
118<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
119<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
120</tr>
121</table>
122&nbsp;<table class="detail">
123<tr class="list">
124<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
125<td class="itemcode"><a name="Clear"></a><code>procedure <b>Clear</b>; virtual;</code></td>
126</tr>
127</table>
128<p>
129Clears all data fields.</p>
130<table class="detail">
131<tr class="list">
132<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
133<td class="itemcode"><a name="EncodeHeaders"></a><code>procedure <b>EncodeHeaders</b>(const Value: TStrings); virtual;</code></td>
134</tr>
135</table>
136&nbsp;<table class="detail">
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"><a name="DecodeHeaders"></a><code>procedure <b>DecodeHeaders</b>(const Value: TStrings);</code></td>
140</tr>
141</table>
142<p>
143Parse header from Value to this object.</p>
144<table class="detail">
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"><a name="FindHeader"></a><code>function <b>FindHeader</b>(Value: string): string;</code></td>
148</tr>
149</table>
150<p>
151Try find specific header in CustomHeader. Search is case insensitive. This is good for reading any non-parsed header.</p>
152<table class="detail">
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"><a name="FindHeaderList"></a><code>procedure <b>FindHeaderList</b>(Value: string; const HeaderList: TStrings);</code></td>
156</tr>
157</table>
158<p>
159Try find specific headers in CustomHeader. This metod is for repeatly used headers like 'received' header, etc. Search is case insensitive. This is good for reading ano non-parsed header.</p>
160<h3 class="detail">Properties</h3>
161<table class="detail">
162<tr class="list">
163<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
164<td class="itemcode"><a name="From"></a><code>property <b>From</b>: string read FFrom Write FFrom;</code></td>
165</tr>
166</table>
167<p>
168Sender of message.</p>
169<table class="detail">
170<tr class="list">
171<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
172<td class="itemcode"><a name="ToList"></a><code>property <b>ToList</b>: TStringList read FToList;</code></td>
173</tr>
174</table>
175<p>
176Stringlist with receivers of message. (one per line)</p>
177<table class="detail">
178<tr class="list">
179<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
180<td class="itemcode"><a name="CCList"></a><code>property <b>CCList</b>: TStringList read FCCList;</code></td>
181</tr>
182</table>
183<p>
184Stringlist with Carbon Copy receivers of message. (one per line)</p>
185<table class="detail">
186<tr class="list">
187<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
188<td class="itemcode"><a name="Subject"></a><code>property <b>Subject</b>: string read FSubject Write FSubject;</code></td>
189</tr>
190</table>
191<p>
192Subject of message.</p>
193<table class="detail">
194<tr class="list">
195<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
196<td class="itemcode"><a name="Organization"></a><code>property <b>Organization</b>: string read FOrganization Write FOrganization;</code></td>
197</tr>
198</table>
199<p>
200Organization string.</p>
201<table class="detail">
202<tr class="list">
203<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
204<td class="itemcode"><a name="CustomHeaders"></a><code>property <b>CustomHeaders</b>: TStringList read FCustomHeaders;</code></td>
205</tr>
206</table>
207<p>
208After decoding contains all headers lines witch not have parsed to any other structures in this object. It mean: this conatins all other headers except:
209
210<p>X-MAILER, FROM, SUBJECT, ORGANIZATION, TO, CC, DATE, MIME-VERSION, CONTENT-TYPE, CONTENT-DESCRIPTION, CONTENT-DISPOSITION, CONTENT-ID, CONTENT-TRANSFER-ENCODING, REPLY-TO, MESSAGE-ID, X-MSMAIL-PRIORITY, X-PRIORITY, PRIORITY
211
212<p>When you encode headers, all this lines is added as headers. Be carefull for duplicites!</p>
213<table class="detail">
214<tr class="list">
215<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
216<td class="itemcode"><a name="Date"></a><code>property <b>Date</b>: TDateTime read FDate Write FDate;</code></td>
217</tr>
218</table>
219<p>
220Date and time of message.</p>
221<table class="detail">
222<tr class="list">
223<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
224<td class="itemcode"><a name="XMailer"></a><code>property <b>XMailer</b>: string read FXMailer Write FXMailer;</code></td>
225</tr>
226</table>
227<p>
228Mailer identification.</p>
229<table class="detail">
230<tr class="list">
231<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
232<td class="itemcode"><a name="ReplyTo"></a><code>property <b>ReplyTo</b>: string read FReplyTo Write FReplyTo;</code></td>
233</tr>
234</table>
235<p>
236Address for replies</p>
237<table class="detail">
238<tr class="list">
239<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
240<td class="itemcode"><a name="MessageID"></a><code>property <b>MessageID</b>: string read FMessageID Write FMessageID;</code></td>
241</tr>
242</table>
243<p>
244message indetifier</p>
245<table class="detail">
246<tr class="list">
247<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
248<td class="itemcode"><a name="Priority"></a><code>property <b>Priority</b>: <a href="mimemess.html#TMessPriority">TMessPriority</a> read FPriority Write FPriority;</code></td>
249</tr>
250</table>
251<p>
252message priority</p>
253<table class="detail">
254<tr class="list">
255<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
256<td class="itemcode"><a name="CharsetCode"></a><code>property <b>CharsetCode</b>: <a href="synachar.html#TMimeChar">TMimeChar</a> read FCharsetCode Write FCharsetCode;</code></td>
257</tr>
258</table>
259<p>
260Specify base charset. By default is used system charset.</p>
261<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>
262</span>
263</body></html>
Note: See TracBrowser for help on using the repository browser.