MailMessage.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  1. <Type Name="MailMessage" FullName="System.Web.Mail.MailMessage">
  2. <TypeSignature Language="C#" Value="public class MailMessage" Maintainer="auto" />
  3. <AssemblyInfo>
  4. <AssemblyName>System.Web</AssemblyName>
  5. <AssemblyPublicKey>
  6. </AssemblyPublicKey>
  7. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  8. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  9. </AssemblyInfo>
  10. <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  11. <Base>
  12. <BaseTypeName>System.Object</BaseTypeName>
  13. </Base>
  14. <Interfaces />
  15. <Docs>
  16. <summary>
  17. <para>
  18. This class is used to construct an email message, possibly with attachments.
  19. </para>
  20. </summary>
  21. <remarks>
  22. <example>
  23. <code lang="C#">
  24. using System;
  25. using System.Web.Mail;
  26. class SmtpExample
  27. {
  28. public static void Main(string[] args)
  29. {
  30. // Construct message
  31. MailMessage msg= new MailMessage();
  32. msg.From = "[email protected]";
  33. msg.To = "[email protected]";
  34. msg.Subject = "An example email";
  35. msg.Body = "&lt;strong&gt;This&lt;strong&gt; is an example of an HTML email.&lt;p&gt;&lt;pre&gt;OK!&lt;/pre&gt;&lt;/p&gt;"
  36. msg.BodyFormat = MailFormat.Html;
  37. // Send via SMTP server
  38. SmtpMail.SmtpServer="smtp.example.com";
  39. SmtpMail.Send(msg);
  40. }
  41. }
  42. </code>
  43. </example>
  44. </remarks>
  45. </Docs>
  46. <Members>
  47. <Member MemberName=".ctor">
  48. <MemberSignature Language="C#" Value="public MailMessage ();" />
  49. <MemberType>Constructor</MemberType>
  50. <ReturnValue />
  51. <Parameters />
  52. <Docs>
  53. <summary>To be added</summary>
  54. <remarks>To be added</remarks>
  55. </Docs>
  56. <AssemblyInfo>
  57. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  58. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  59. </AssemblyInfo>
  60. </Member>
  61. <Member MemberName="Attachments">
  62. <MemberSignature Language="C#" Value="public System.Collections.IList Attachments { get; }" />
  63. <MemberType>Property</MemberType>
  64. <ReturnValue>
  65. <ReturnType>System.Collections.IList</ReturnType>
  66. </ReturnValue>
  67. <Parameters />
  68. <Docs>
  69. <summary>To be added</summary>
  70. <value>a <see cref="T:System.Collections.IList" /></value>
  71. <remarks>To be added</remarks>
  72. </Docs>
  73. <AssemblyInfo>
  74. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  75. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  76. </AssemblyInfo>
  77. </Member>
  78. <Member MemberName="Bcc">
  79. <MemberSignature Language="C#" Value="public string Bcc { set; get; }" />
  80. <MemberType>Property</MemberType>
  81. <ReturnValue>
  82. <ReturnType>System.String</ReturnType>
  83. </ReturnValue>
  84. <Parameters />
  85. <Docs>
  86. <summary>To be added</summary>
  87. <value>To be added: an object of type 'string'</value>
  88. <remarks>To be added</remarks>
  89. </Docs>
  90. <AssemblyInfo>
  91. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  92. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  93. </AssemblyInfo>
  94. </Member>
  95. <Member MemberName="Body">
  96. <MemberSignature Language="C#" Value="public string Body { set; get; }" />
  97. <MemberType>Property</MemberType>
  98. <ReturnValue>
  99. <ReturnType>System.String</ReturnType>
  100. </ReturnValue>
  101. <Parameters />
  102. <Docs>
  103. <summary>To be added</summary>
  104. <value>To be added: an object of type 'string'</value>
  105. <remarks>To be added</remarks>
  106. </Docs>
  107. <AssemblyInfo>
  108. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  109. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  110. </AssemblyInfo>
  111. </Member>
  112. <Member MemberName="BodyEncoding">
  113. <MemberSignature Language="C#" Value="public System.Text.Encoding BodyEncoding { set; get; }" />
  114. <MemberType>Property</MemberType>
  115. <ReturnValue>
  116. <ReturnType>System.Text.Encoding</ReturnType>
  117. </ReturnValue>
  118. <Parameters />
  119. <Docs>
  120. <summary>The encoding of the text in the e-mail body. Default is utf8.</summary>
  121. <value>a <see cref="T:System.Text.Encoding" /></value>
  122. <remarks>To be added</remarks>
  123. </Docs>
  124. <AssemblyInfo>
  125. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  126. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  127. </AssemblyInfo>
  128. </Member>
  129. <Member MemberName="BodyFormat">
  130. <MemberSignature Language="C#" Value="public System.Web.Mail.MailFormat BodyFormat { set; get; }" />
  131. <MemberType>Property</MemberType>
  132. <ReturnValue>
  133. <ReturnType>System.Web.Mail.MailFormat</ReturnType>
  134. </ReturnValue>
  135. <Parameters />
  136. <Docs>
  137. <summary>To be added</summary>
  138. <value>To be added: an object of type 'MailFormat'</value>
  139. <remarks>To be added</remarks>
  140. </Docs>
  141. <AssemblyInfo>
  142. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  143. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  144. </AssemblyInfo>
  145. </Member>
  146. <Member MemberName="Cc">
  147. <MemberSignature Language="C#" Value="public string Cc { set; get; }" />
  148. <MemberType>Property</MemberType>
  149. <ReturnValue>
  150. <ReturnType>System.String</ReturnType>
  151. </ReturnValue>
  152. <Parameters />
  153. <Docs>
  154. <summary>To be added</summary>
  155. <value>To be added: an object of type 'string'</value>
  156. <remarks>To be added</remarks>
  157. </Docs>
  158. <AssemblyInfo>
  159. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  160. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  161. </AssemblyInfo>
  162. </Member>
  163. <Member MemberName="Fields">
  164. <MemberSignature Language="C#" Value="public System.Collections.IDictionary Fields { get; }" />
  165. <MemberType>Property</MemberType>
  166. <ReturnValue>
  167. <ReturnType>System.Collections.IDictionary</ReturnType>
  168. </ReturnValue>
  169. <Docs>
  170. <summary>To be added.</summary>
  171. <value>To be added.</value>
  172. <remarks>To be added.</remarks>
  173. </Docs>
  174. <AssemblyInfo>
  175. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  176. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  177. </AssemblyInfo>
  178. </Member>
  179. <Member MemberName="From">
  180. <MemberSignature Language="C#" Value="public string From { set; get; }" />
  181. <MemberType>Property</MemberType>
  182. <ReturnValue>
  183. <ReturnType>System.String</ReturnType>
  184. </ReturnValue>
  185. <Parameters />
  186. <Docs>
  187. <summary>To be added</summary>
  188. <value>To be added: an object of type 'string'</value>
  189. <remarks>To be added</remarks>
  190. </Docs>
  191. <AssemblyInfo>
  192. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  193. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  194. </AssemblyInfo>
  195. </Member>
  196. <Member MemberName="Headers">
  197. <MemberSignature Language="C#" Value="public System.Collections.IDictionary Headers { get; }" />
  198. <MemberType>Property</MemberType>
  199. <ReturnValue>
  200. <ReturnType>System.Collections.IDictionary</ReturnType>
  201. </ReturnValue>
  202. <Parameters />
  203. <Docs>
  204. <summary>To be added</summary>
  205. <value>a <see cref="T:System.Collections.IDictionary" /></value>
  206. <remarks>To be added</remarks>
  207. </Docs>
  208. <AssemblyInfo>
  209. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  210. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  211. </AssemblyInfo>
  212. </Member>
  213. <Member MemberName="Priority">
  214. <MemberSignature Language="C#" Value="public System.Web.Mail.MailPriority Priority { set; get; }" />
  215. <MemberType>Property</MemberType>
  216. <ReturnValue>
  217. <ReturnType>System.Web.Mail.MailPriority</ReturnType>
  218. </ReturnValue>
  219. <Parameters />
  220. <Docs>
  221. <summary>To be added</summary>
  222. <value>To be added: an object of type 'MailPriority'</value>
  223. <remarks>To be added</remarks>
  224. </Docs>
  225. <AssemblyInfo>
  226. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  227. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  228. </AssemblyInfo>
  229. </Member>
  230. <Member MemberName="Subject">
  231. <MemberSignature Language="C#" Value="public string Subject { set; get; }" />
  232. <MemberType>Property</MemberType>
  233. <ReturnValue>
  234. <ReturnType>System.String</ReturnType>
  235. </ReturnValue>
  236. <Parameters />
  237. <Docs>
  238. <summary>To be added</summary>
  239. <value>To be added: an object of type 'string'</value>
  240. <remarks>To be added</remarks>
  241. </Docs>
  242. <AssemblyInfo>
  243. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  244. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  245. </AssemblyInfo>
  246. </Member>
  247. <Member MemberName="To">
  248. <MemberSignature Language="C#" Value="public string To { set; get; }" />
  249. <MemberType>Property</MemberType>
  250. <ReturnValue>
  251. <ReturnType>System.String</ReturnType>
  252. </ReturnValue>
  253. <Parameters />
  254. <Docs>
  255. <summary>To be added</summary>
  256. <value>To be added: an object of type 'string'</value>
  257. <remarks>To be added</remarks>
  258. </Docs>
  259. <AssemblyInfo>
  260. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  261. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  262. </AssemblyInfo>
  263. </Member>
  264. <Member MemberName="UrlContentBase">
  265. <MemberSignature Language="C#" Value="public string UrlContentBase { set; get; }" />
  266. <MemberType>Property</MemberType>
  267. <ReturnValue>
  268. <ReturnType>System.String</ReturnType>
  269. </ReturnValue>
  270. <Parameters />
  271. <Docs>
  272. <summary>To be added</summary>
  273. <value>To be added: an object of type 'string'</value>
  274. <remarks>To be added</remarks>
  275. </Docs>
  276. <AssemblyInfo>
  277. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  278. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  279. </AssemblyInfo>
  280. </Member>
  281. <Member MemberName="UrlContentLocation">
  282. <MemberSignature Language="C#" Value="public string UrlContentLocation { set; get; }" />
  283. <MemberType>Property</MemberType>
  284. <ReturnValue>
  285. <ReturnType>System.String</ReturnType>
  286. </ReturnValue>
  287. <Parameters />
  288. <Docs>
  289. <summary>To be added</summary>
  290. <value>To be added: an object of type 'string'</value>
  291. <remarks>To be added</remarks>
  292. </Docs>
  293. <AssemblyInfo>
  294. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  295. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  296. </AssemblyInfo>
  297. </Member>
  298. </Members>
  299. <Attributes>
  300. <Attribute>
  301. <AttributeName>System.Obsolete("The recommended alternative is System.Net.Mail.MailMessage.")</AttributeName>
  302. </Attribute>
  303. </Attributes>
  304. </Type>