docupdate: updated System.dll documentation
[mono.git] / mcs / class / System / Documentation / en / System.Net.Mail / MailMessage.xml
1 <Type Name="MailMessage" FullName="System.Net.Mail.MailMessage">
2   <TypeSignature Language="C#" Value="public class MailMessage : IDisposable" />
3   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MailMessage extends System.Object implements class System.IDisposable" />
4   <AssemblyInfo>
5     <AssemblyName>System</AssemblyName>
6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
8   </AssemblyInfo>
9   <Base>
10     <BaseTypeName>System.Object</BaseTypeName>
11   </Base>
12   <Interfaces>
13     <Interface>
14       <InterfaceName>System.IDisposable</InterfaceName>
15     </Interface>
16   </Interfaces>
17   <Docs>
18     <summary>To be added.</summary>
19     <remarks>To be added.</remarks>
20     <since version=".NET 2.0" />
21   </Docs>
22   <Members>
23     <Member MemberName=".ctor">
24       <MemberSignature Language="C#" Value="public MailMessage ();" />
25       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
26       <MemberType>Constructor</MemberType>
27       <AssemblyInfo>
28         <AssemblyVersion>2.0.0.0</AssemblyVersion>
29         <AssemblyVersion>4.0.0.0</AssemblyVersion>
30       </AssemblyInfo>
31       <Parameters />
32       <Docs>
33         <summary>To be added.</summary>
34         <remarks>To be added.</remarks>
35         <since version=".NET 2.0" />
36       </Docs>
37     </Member>
38     <Member MemberName=".ctor">
39       <MemberSignature Language="C#" Value="public MailMessage (System.Net.Mail.MailAddress from, System.Net.Mail.MailAddress to);" />
40       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Net.Mail.MailAddress from, class System.Net.Mail.MailAddress to) cil managed" />
41       <MemberType>Constructor</MemberType>
42       <AssemblyInfo>
43         <AssemblyVersion>2.0.0.0</AssemblyVersion>
44         <AssemblyVersion>4.0.0.0</AssemblyVersion>
45       </AssemblyInfo>
46       <Parameters>
47         <Parameter Name="from" Type="System.Net.Mail.MailAddress" />
48         <Parameter Name="to" Type="System.Net.Mail.MailAddress" />
49       </Parameters>
50       <Docs>
51         <param name="from">To be added.</param>
52         <param name="to">To be added.</param>
53         <summary>To be added.</summary>
54         <remarks>To be added.</remarks>
55         <since version=".NET 2.0" />
56       </Docs>
57     </Member>
58     <Member MemberName=".ctor">
59       <MemberSignature Language="C#" Value="public MailMessage (string from, string to);" />
60       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string from, string to) cil managed" />
61       <MemberType>Constructor</MemberType>
62       <AssemblyInfo>
63         <AssemblyVersion>2.0.0.0</AssemblyVersion>
64         <AssemblyVersion>4.0.0.0</AssemblyVersion>
65       </AssemblyInfo>
66       <Parameters>
67         <Parameter Name="from" Type="System.String" />
68         <Parameter Name="to" Type="System.String" />
69       </Parameters>
70       <Docs>
71         <param name="from">To be added.</param>
72         <param name="to">To be added.</param>
73         <summary>To be added.</summary>
74         <remarks>To be added.</remarks>
75         <since version=".NET 2.0" />
76       </Docs>
77     </Member>
78     <Member MemberName=".ctor">
79       <MemberSignature Language="C#" Value="public MailMessage (string from, string to, string subject, string body);" />
80       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string from, string to, string subject, string body) cil managed" />
81       <MemberType>Constructor</MemberType>
82       <AssemblyInfo>
83         <AssemblyVersion>2.0.0.0</AssemblyVersion>
84         <AssemblyVersion>4.0.0.0</AssemblyVersion>
85       </AssemblyInfo>
86       <Parameters>
87         <Parameter Name="from" Type="System.String" />
88         <Parameter Name="to" Type="System.String" />
89         <Parameter Name="subject" Type="System.String" />
90         <Parameter Name="body" Type="System.String" />
91       </Parameters>
92       <Docs>
93         <param name="from">To be added.</param>
94         <param name="to">To be added.</param>
95         <param name="subject">To be added.</param>
96         <param name="body">To be added.</param>
97         <summary>To be added.</summary>
98         <remarks>To be added.</remarks>
99         <since version=".NET 2.0" />
100       </Docs>
101     </Member>
102     <Member MemberName="AlternateViews">
103       <MemberSignature Language="C#" Value="public System.Net.Mail.AlternateViewCollection AlternateViews { get; }" />
104       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.AlternateViewCollection AlternateViews" />
105       <MemberType>Property</MemberType>
106       <AssemblyInfo>
107         <AssemblyVersion>2.0.0.0</AssemblyVersion>
108         <AssemblyVersion>4.0.0.0</AssemblyVersion>
109       </AssemblyInfo>
110       <ReturnValue>
111         <ReturnType>System.Net.Mail.AlternateViewCollection</ReturnType>
112       </ReturnValue>
113       <Docs>
114         <summary>To be added.</summary>
115         <value>To be added.</value>
116         <remarks>To be added.</remarks>
117         <since version=".NET 2.0" />
118       </Docs>
119     </Member>
120     <Member MemberName="Attachments">
121       <MemberSignature Language="C#" Value="public System.Net.Mail.AttachmentCollection Attachments { get; }" />
122       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.AttachmentCollection Attachments" />
123       <MemberType>Property</MemberType>
124       <AssemblyInfo>
125         <AssemblyVersion>2.0.0.0</AssemblyVersion>
126         <AssemblyVersion>4.0.0.0</AssemblyVersion>
127       </AssemblyInfo>
128       <ReturnValue>
129         <ReturnType>System.Net.Mail.AttachmentCollection</ReturnType>
130       </ReturnValue>
131       <Docs>
132         <summary>To be added.</summary>
133         <value>To be added.</value>
134         <remarks>To be added.</remarks>
135         <since version=".NET 2.0" />
136       </Docs>
137     </Member>
138     <Member MemberName="Bcc">
139       <MemberSignature Language="C#" Value="public System.Net.Mail.MailAddressCollection Bcc { get; }" />
140       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.MailAddressCollection Bcc" />
141       <MemberType>Property</MemberType>
142       <AssemblyInfo>
143         <AssemblyVersion>2.0.0.0</AssemblyVersion>
144         <AssemblyVersion>4.0.0.0</AssemblyVersion>
145       </AssemblyInfo>
146       <ReturnValue>
147         <ReturnType>System.Net.Mail.MailAddressCollection</ReturnType>
148       </ReturnValue>
149       <Docs>
150         <summary>To be added.</summary>
151         <value>To be added.</value>
152         <remarks>To be added.</remarks>
153         <since version=".NET 2.0" />
154       </Docs>
155     </Member>
156     <Member MemberName="Body">
157       <MemberSignature Language="C#" Value="public string Body { get; set; }" />
158       <MemberSignature Language="ILAsm" Value=".property instance string Body" />
159       <MemberType>Property</MemberType>
160       <AssemblyInfo>
161         <AssemblyVersion>2.0.0.0</AssemblyVersion>
162         <AssemblyVersion>4.0.0.0</AssemblyVersion>
163       </AssemblyInfo>
164       <ReturnValue>
165         <ReturnType>System.String</ReturnType>
166       </ReturnValue>
167       <Docs>
168         <summary>To be added.</summary>
169         <value>To be added.</value>
170         <remarks>To be added.</remarks>
171         <since version=".NET 2.0" />
172       </Docs>
173     </Member>
174     <Member MemberName="BodyEncoding">
175       <MemberSignature Language="C#" Value="public System.Text.Encoding BodyEncoding { get; set; }" />
176       <MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding BodyEncoding" />
177       <MemberType>Property</MemberType>
178       <AssemblyInfo>
179         <AssemblyVersion>2.0.0.0</AssemblyVersion>
180         <AssemblyVersion>4.0.0.0</AssemblyVersion>
181       </AssemblyInfo>
182       <ReturnValue>
183         <ReturnType>System.Text.Encoding</ReturnType>
184       </ReturnValue>
185       <Docs>
186         <summary>To be added.</summary>
187         <value>To be added.</value>
188         <remarks>To be added.</remarks>
189         <since version=".NET 2.0" />
190       </Docs>
191     </Member>
192     <Member MemberName="CC">
193       <MemberSignature Language="C#" Value="public System.Net.Mail.MailAddressCollection CC { get; }" />
194       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.MailAddressCollection CC" />
195       <MemberType>Property</MemberType>
196       <AssemblyInfo>
197         <AssemblyVersion>2.0.0.0</AssemblyVersion>
198         <AssemblyVersion>4.0.0.0</AssemblyVersion>
199       </AssemblyInfo>
200       <ReturnValue>
201         <ReturnType>System.Net.Mail.MailAddressCollection</ReturnType>
202       </ReturnValue>
203       <Docs>
204         <summary>To be added.</summary>
205         <value>To be added.</value>
206         <remarks>To be added.</remarks>
207         <since version=".NET 2.0" />
208       </Docs>
209     </Member>
210     <Member MemberName="DeliveryNotificationOptions">
211       <MemberSignature Language="C#" Value="public System.Net.Mail.DeliveryNotificationOptions DeliveryNotificationOptions { get; set; }" />
212       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Mail.DeliveryNotificationOptions DeliveryNotificationOptions" />
213       <MemberType>Property</MemberType>
214       <AssemblyInfo>
215         <AssemblyVersion>2.0.0.0</AssemblyVersion>
216         <AssemblyVersion>4.0.0.0</AssemblyVersion>
217       </AssemblyInfo>
218       <ReturnValue>
219         <ReturnType>System.Net.Mail.DeliveryNotificationOptions</ReturnType>
220       </ReturnValue>
221       <Docs>
222         <summary>To be added.</summary>
223         <value>To be added.</value>
224         <remarks>To be added.</remarks>
225         <since version=".NET 2.0" />
226       </Docs>
227     </Member>
228     <Member MemberName="Dispose">
229       <MemberSignature Language="C#" Value="public void Dispose ();" />
230       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
231       <MemberType>Method</MemberType>
232       <AssemblyInfo>
233         <AssemblyVersion>2.0.0.0</AssemblyVersion>
234         <AssemblyVersion>4.0.0.0</AssemblyVersion>
235       </AssemblyInfo>
236       <ReturnValue>
237         <ReturnType>System.Void</ReturnType>
238       </ReturnValue>
239       <Parameters />
240       <Docs>
241         <summary>To be added.</summary>
242         <remarks>To be added.</remarks>
243         <since version=".NET 2.0" />
244       </Docs>
245     </Member>
246     <Member MemberName="Dispose">
247       <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
248       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
249       <MemberType>Method</MemberType>
250       <AssemblyInfo>
251         <AssemblyVersion>2.0.0.0</AssemblyVersion>
252         <AssemblyVersion>4.0.0.0</AssemblyVersion>
253       </AssemblyInfo>
254       <ReturnValue>
255         <ReturnType>System.Void</ReturnType>
256       </ReturnValue>
257       <Parameters>
258         <Parameter Name="disposing" Type="System.Boolean" />
259       </Parameters>
260       <Docs>
261         <param name="disposing">To be added.</param>
262         <summary>To be added.</summary>
263         <remarks>To be added.</remarks>
264         <since version=".NET 2.0" />
265       </Docs>
266     </Member>
267     <Member MemberName="From">
268       <MemberSignature Language="C#" Value="public System.Net.Mail.MailAddress From { get; set; }" />
269       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.MailAddress From" />
270       <MemberType>Property</MemberType>
271       <AssemblyInfo>
272         <AssemblyVersion>2.0.0.0</AssemblyVersion>
273         <AssemblyVersion>4.0.0.0</AssemblyVersion>
274       </AssemblyInfo>
275       <ReturnValue>
276         <ReturnType>System.Net.Mail.MailAddress</ReturnType>
277       </ReturnValue>
278       <Docs>
279         <summary>To be added.</summary>
280         <value>To be added.</value>
281         <remarks>To be added.</remarks>
282         <since version=".NET 2.0" />
283       </Docs>
284     </Member>
285     <Member MemberName="Headers">
286       <MemberSignature Language="C#" Value="public System.Collections.Specialized.NameValueCollection Headers { get; }" />
287       <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Specialized.NameValueCollection Headers" />
288       <MemberType>Property</MemberType>
289       <AssemblyInfo>
290         <AssemblyVersion>2.0.0.0</AssemblyVersion>
291         <AssemblyVersion>4.0.0.0</AssemblyVersion>
292       </AssemblyInfo>
293       <ReturnValue>
294         <ReturnType>System.Collections.Specialized.NameValueCollection</ReturnType>
295       </ReturnValue>
296       <Docs>
297         <summary>To be added.</summary>
298         <value>To be added.</value>
299         <remarks>To be added.</remarks>
300         <since version=".NET 2.0" />
301       </Docs>
302     </Member>
303     <Member MemberName="HeadersEncoding">
304       <MemberSignature Language="C#" Value="public System.Text.Encoding HeadersEncoding { get; set; }" />
305       <MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding HeadersEncoding" />
306       <MemberType>Property</MemberType>
307       <AssemblyInfo>
308         <AssemblyVersion>4.0.0.0</AssemblyVersion>
309       </AssemblyInfo>
310       <ReturnValue>
311         <ReturnType>System.Text.Encoding</ReturnType>
312       </ReturnValue>
313       <Docs>
314         <summary>To be added.</summary>
315         <value>To be added.</value>
316         <remarks>To be added.</remarks>
317       </Docs>
318     </Member>
319     <Member MemberName="IsBodyHtml">
320       <MemberSignature Language="C#" Value="public bool IsBodyHtml { get; set; }" />
321       <MemberSignature Language="ILAsm" Value=".property instance bool IsBodyHtml" />
322       <MemberType>Property</MemberType>
323       <AssemblyInfo>
324         <AssemblyVersion>2.0.0.0</AssemblyVersion>
325         <AssemblyVersion>4.0.0.0</AssemblyVersion>
326       </AssemblyInfo>
327       <ReturnValue>
328         <ReturnType>System.Boolean</ReturnType>
329       </ReturnValue>
330       <Docs>
331         <summary>To be added.</summary>
332         <value>To be added.</value>
333         <remarks>To be added.</remarks>
334         <since version=".NET 2.0" />
335       </Docs>
336     </Member>
337     <Member MemberName="Priority">
338       <MemberSignature Language="C#" Value="public System.Net.Mail.MailPriority Priority { get; set; }" />
339       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Mail.MailPriority Priority" />
340       <MemberType>Property</MemberType>
341       <AssemblyInfo>
342         <AssemblyVersion>2.0.0.0</AssemblyVersion>
343         <AssemblyVersion>4.0.0.0</AssemblyVersion>
344       </AssemblyInfo>
345       <ReturnValue>
346         <ReturnType>System.Net.Mail.MailPriority</ReturnType>
347       </ReturnValue>
348       <Docs>
349         <summary>To be added.</summary>
350         <value>To be added.</value>
351         <remarks>To be added.</remarks>
352         <since version=".NET 2.0" />
353       </Docs>
354     </Member>
355     <Member MemberName="ReplyTo">
356       <MemberSignature Language="C#" Value="public System.Net.Mail.MailAddress ReplyTo { get; set; }" />
357       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.MailAddress ReplyTo" />
358       <MemberType>Property</MemberType>
359       <AssemblyInfo>
360         <AssemblyVersion>2.0.0.0</AssemblyVersion>
361         <AssemblyVersion>4.0.0.0</AssemblyVersion>
362       </AssemblyInfo>
363       <Attributes>
364         <Attribute>
365           <AttributeName>System.Obsolete("Use ReplyToList instead")</AttributeName>
366         </Attribute>
367       </Attributes>
368       <ReturnValue>
369         <ReturnType>System.Net.Mail.MailAddress</ReturnType>
370       </ReturnValue>
371       <Docs>
372         <summary>To be added.</summary>
373         <value>To be added.</value>
374         <remarks>To be added.</remarks>
375         <since version=".NET 2.0" />
376       </Docs>
377     </Member>
378     <Member MemberName="ReplyToList">
379       <MemberSignature Language="C#" Value="public System.Net.Mail.MailAddressCollection ReplyToList { get; }" />
380       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.MailAddressCollection ReplyToList" />
381       <MemberType>Property</MemberType>
382       <AssemblyInfo>
383         <AssemblyVersion>4.0.0.0</AssemblyVersion>
384       </AssemblyInfo>
385       <ReturnValue>
386         <ReturnType>System.Net.Mail.MailAddressCollection</ReturnType>
387       </ReturnValue>
388       <Docs>
389         <summary>To be added.</summary>
390         <value>To be added.</value>
391         <remarks>To be added.</remarks>
392       </Docs>
393     </Member>
394     <Member MemberName="Sender">
395       <MemberSignature Language="C#" Value="public System.Net.Mail.MailAddress Sender { get; set; }" />
396       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.MailAddress Sender" />
397       <MemberType>Property</MemberType>
398       <AssemblyInfo>
399         <AssemblyVersion>2.0.0.0</AssemblyVersion>
400         <AssemblyVersion>4.0.0.0</AssemblyVersion>
401       </AssemblyInfo>
402       <ReturnValue>
403         <ReturnType>System.Net.Mail.MailAddress</ReturnType>
404       </ReturnValue>
405       <Docs>
406         <summary>To be added.</summary>
407         <value>To be added.</value>
408         <remarks>To be added.</remarks>
409         <since version=".NET 2.0" />
410       </Docs>
411     </Member>
412     <Member MemberName="Subject">
413       <MemberSignature Language="C#" Value="public string Subject { get; set; }" />
414       <MemberSignature Language="ILAsm" Value=".property instance string Subject" />
415       <MemberType>Property</MemberType>
416       <AssemblyInfo>
417         <AssemblyVersion>2.0.0.0</AssemblyVersion>
418         <AssemblyVersion>4.0.0.0</AssemblyVersion>
419       </AssemblyInfo>
420       <ReturnValue>
421         <ReturnType>System.String</ReturnType>
422       </ReturnValue>
423       <Docs>
424         <summary>To be added.</summary>
425         <value>To be added.</value>
426         <remarks>To be added.</remarks>
427         <since version=".NET 2.0" />
428       </Docs>
429     </Member>
430     <Member MemberName="SubjectEncoding">
431       <MemberSignature Language="C#" Value="public System.Text.Encoding SubjectEncoding { get; set; }" />
432       <MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding SubjectEncoding" />
433       <MemberType>Property</MemberType>
434       <AssemblyInfo>
435         <AssemblyVersion>2.0.0.0</AssemblyVersion>
436         <AssemblyVersion>4.0.0.0</AssemblyVersion>
437       </AssemblyInfo>
438       <ReturnValue>
439         <ReturnType>System.Text.Encoding</ReturnType>
440       </ReturnValue>
441       <Docs>
442         <summary>To be added.</summary>
443         <value>To be added.</value>
444         <remarks>To be added.</remarks>
445         <since version=".NET 2.0" />
446       </Docs>
447     </Member>
448     <Member MemberName="To">
449       <MemberSignature Language="C#" Value="public System.Net.Mail.MailAddressCollection To { get; }" />
450       <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mail.MailAddressCollection To" />
451       <MemberType>Property</MemberType>
452       <AssemblyInfo>
453         <AssemblyVersion>2.0.0.0</AssemblyVersion>
454         <AssemblyVersion>4.0.0.0</AssemblyVersion>
455       </AssemblyInfo>
456       <ReturnValue>
457         <ReturnType>System.Net.Mail.MailAddressCollection</ReturnType>
458       </ReturnValue>
459       <Docs>
460         <summary>To be added.</summary>
461         <value>To be added.</value>
462         <remarks>To be added.</remarks>
463         <since version=".NET 2.0" />
464       </Docs>
465     </Member>
466   </Members>
467 </Type>