mcs/class/System/Documentation/en/System.Net.Configuration/SmtpNetworkElement.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="SmtpNetworkElement" FullName="System.Net.Configuration.SmtpNetworkElement">
   3   <TypeSignature Language="C#" Value="public sealed class SmtpNetworkElement : System.Configuration.ConfigurationElement" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SmtpNetworkElement extends System.Configuration.ConfigurationElement" />
   5   <AssemblyInfo>
   6     <AssemblyName>System</AssemblyName>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   9   </AssemblyInfo>
  10   <Base>
  11     <BaseTypeName>System.Configuration.ConfigurationElement</BaseTypeName>
  12   </Base>
  13   <Interfaces />
  14   <Docs>
  15     <since version=".NET 2.0" />
  16     <remarks>
  17       <attribution license="cc4" from="Microsoft" modified="false" />
  18       <para>Use this class to configure an SMTP client.</para>
  19     </remarks>
  20     <summary>
  21       <attribution license="cc4" from="Microsoft" modified="false" />
  22       <para>Represents the network element in the SMTP configuration file. This class cannot be inherited.</para>
  23     </summary>
  24   </Docs>
  25   <Members>
  26     <Member MemberName=".ctor">
  27       <MemberSignature Language="C#" Value="public SmtpNetworkElement ();" />
  28       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  29       <MemberType>Constructor</MemberType>
  30       <AssemblyInfo>
  31         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  32         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  33       </AssemblyInfo>
  34       <Parameters />
  35       <Docs>
  36         <remarks>To be added.</remarks>
  37         <since version=".NET 2.0" />
  38         <summary>
  39           <attribution license="cc4" from="Microsoft" modified="false" />
  40           <para>Initializes a new instance of the <see cref="T:System.Net.Configuration.SmtpNetworkElement" /> class.</para>
  41         </summary>
  42       </Docs>
  43     </Member>
  44     <Member MemberName="DefaultCredentials">
  45       <MemberSignature Language="C#" Value="public bool DefaultCredentials { get; set; }" />
  46       <MemberSignature Language="ILAsm" Value=".property instance bool DefaultCredentials" />
  47       <MemberType>Property</MemberType>
  48       <AssemblyInfo>
  49         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  50         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  51       </AssemblyInfo>
  52       <Attributes>
  53         <Attribute>
  54           <AttributeName>System.Configuration.ConfigurationProperty("defaultCredentials", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
  55         </Attribute>
  56       </Attributes>
  57       <ReturnValue>
  58         <ReturnType>System.Boolean</ReturnType>
  59       </ReturnValue>
  60       <Docs>
  61         <value>To be added.</value>
  62         <remarks>To be added.</remarks>
  63         <since version=".NET 2.0" />
  64         <summary>
  65           <attribution license="cc4" from="Microsoft" modified="false" />
  66           <para>Determines whether or not default user credentials are used to access an SMTP server. The default value is false.</para>
  67         </summary>
  68       </Docs>
  69     </Member>
  70     <Member MemberName="EnableSsl">
  71       <MemberSignature Language="C#" Value="public bool EnableSsl { get; set; }" />
  72       <MemberSignature Language="ILAsm" Value=".property instance bool EnableSsl" />
  73       <MemberType>Property</MemberType>
  74       <AssemblyInfo>
  75         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  76       </AssemblyInfo>
  77       <Attributes>
  78         <Attribute>
  79           <AttributeName>System.Configuration.ConfigurationProperty("enableSsl", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
  80         </Attribute>
  81       </Attributes>
  82       <ReturnValue>
  83         <ReturnType>System.Boolean</ReturnType>
  84       </ReturnValue>
  85       <Docs>
  86         <value>To be added.</value>
  87         <remarks>
  88           <attribution license="cc4" from="Microsoft" modified="false" />
  89           <para>The <see cref="P:System.Net.Configuration.SmtpNetworkElement.EnableSsl" /> property indicates if SSL is used to access an SMTP mail server. The <see cref="T:System.Net.Mail.SmtpClient" /> class only supports the SMTP Service Extension for Secure SMTP over Transport Layer Security as defined in RFC 3207. In this mode, the SMTP session begins on an unencrypted channel, then a STARTTLS command is issued by the client to the server to switch to secure communication using SSL. See RFC 3207 published by the Internet Engineering Task Force (IETF) for more information. </para>
  90           <para>An alternate connection method is where an SSL session is established up front before any protocol commands are sent. This connection method is sometimes called SMTPS and by default uses port 465. This alternate connection method using SSL is not currently supported.</para>
  91         </remarks>
  92         <summary>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <para>Gets or sets whether SSL is used to access an SMTP mail server. The default value is false.</para>
  95         </summary>
  96       </Docs>
  97     </Member>
  98     <Member MemberName="Host">
  99       <MemberSignature Language="C#" Value="public string Host { get; set; }" />
 100       <MemberSignature Language="ILAsm" Value=".property instance string Host" />
 101       <MemberType>Property</MemberType>
 102       <AssemblyInfo>
 103         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 104         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 105       </AssemblyInfo>
 106       <Attributes>
 107         <Attribute>
 108           <AttributeName>System.Configuration.ConfigurationProperty("host")</AttributeName>
 109         </Attribute>
 110       </Attributes>
 111       <ReturnValue>
 112         <ReturnType>System.String</ReturnType>
 113       </ReturnValue>
 114       <Docs>
 115         <value>To be added.</value>
 116         <remarks>To be added.</remarks>
 117         <since version=".NET 2.0" />
 118         <summary>
 119           <attribution license="cc4" from="Microsoft" modified="false" />
 120           <para>Gets or sets the name of the SMTP server.</para>
 121         </summary>
 122       </Docs>
 123     </Member>
 124     <Member MemberName="Password">
 125       <MemberSignature Language="C#" Value="public string Password { get; set; }" />
 126       <MemberSignature Language="ILAsm" Value=".property instance string Password" />
 127       <MemberType>Property</MemberType>
 128       <AssemblyInfo>
 129         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 130         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 131       </AssemblyInfo>
 132       <Attributes>
 133         <Attribute>
 134           <AttributeName>System.Configuration.ConfigurationProperty("password")</AttributeName>
 135         </Attribute>
 136       </Attributes>
 137       <ReturnValue>
 138         <ReturnType>System.String</ReturnType>
 139       </ReturnValue>
 140       <Docs>
 141         <value>To be added.</value>
 142         <since version=".NET 2.0" />
 143         <remarks>
 144           <attribution license="cc4" from="Microsoft" modified="false" />
 145           <para>Setting <see cref="P:System.Net.Configuration.SmtpNetworkElement.DefaultCredentials" /> takes precedence over setting <see cref="P:System.Net.Configuration.SmtpNetworkElement.UserName" /> and <see cref="P:System.Net.Configuration.SmtpNetworkElement.Password" />. <see cref="P:System.Net.Configuration.SmtpNetworkElement.UserName" /> and <see cref="P:System.Net.Configuration.SmtpNetworkElement.Password" /> are used only if <see cref="P:System.Net.Configuration.SmtpNetworkElement.DefaultCredentials" /> is set to false.</para>
 146         </remarks>
 147         <summary>
 148           <attribution license="cc4" from="Microsoft" modified="false" />
 149           <para>Gets or sets the user password to use to connect to an SMTP mail server.</para>
 150         </summary>
 151       </Docs>
 152     </Member>
 153     <Member MemberName="Port">
 154       <MemberSignature Language="C#" Value="public int Port { get; set; }" />
 155       <MemberSignature Language="ILAsm" Value=".property instance int32 Port" />
 156       <MemberType>Property</MemberType>
 157       <AssemblyInfo>
 158         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 159         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 160       </AssemblyInfo>
 161       <Attributes>
 162         <Attribute>
 163           <AttributeName>System.Configuration.ConfigurationProperty("port", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
 164         </Attribute>
 165       </Attributes>
 166       <ReturnValue>
 167         <ReturnType>System.Int32</ReturnType>
 168       </ReturnValue>
 169       <Docs>
 170         <value>To be added.</value>
 171         <remarks>To be added.</remarks>
 172         <since version=".NET 2.0" />
 173         <summary>
 174           <attribution license="cc4" from="Microsoft" modified="false" />
 175           <para>Gets or sets the port that SMTP clients use to connect to an SMTP mail server. The default value is 25.</para>
 176         </summary>
 177       </Docs>
 178     </Member>
 179     <Member MemberName="PostDeserialize">
 180       <MemberSignature Language="C#" Value="protected override void PostDeserialize ();" />
 181       <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void PostDeserialize() cil managed" />
 182       <MemberType>Method</MemberType>
 183       <AssemblyInfo>
 184         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 185         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 186       </AssemblyInfo>
 187       <ReturnValue>
 188         <ReturnType>System.Void</ReturnType>
 189       </ReturnValue>
 190       <Parameters />
 191       <Docs>
 192         <summary>To be added.</summary>
 193         <remarks>To be added.</remarks>
 194       </Docs>
 195     </Member>
 196     <Member MemberName="Properties">
 197       <MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
 198       <MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ConfigurationPropertyCollection Properties" />
 199       <MemberType>Property</MemberType>
 200       <AssemblyInfo>
 201         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 202         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 203       </AssemblyInfo>
 204       <ReturnValue>
 205         <ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
 206       </ReturnValue>
 207       <Docs>
 208         <summary>To be added.</summary>
 209         <value>To be added.</value>
 210         <remarks>To be added.</remarks>
 211       </Docs>
 212     </Member>
 213     <Member MemberName="TargetName">
 214       <MemberSignature Language="C#" Value="public string TargetName { get; set; }" />
 215       <MemberSignature Language="ILAsm" Value=".property instance string TargetName" />
 216       <MemberType>Property</MemberType>
 217       <AssemblyInfo>
 218         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 219       </AssemblyInfo>
 220       <Attributes>
 221         <Attribute>
 222           <AttributeName>System.Configuration.ConfigurationProperty("targetName", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
 223         </Attribute>
 224       </Attributes>
 225       <ReturnValue>
 226         <ReturnType>System.String</ReturnType>
 227       </ReturnValue>
 228       <Docs>
 229         <value>To be added.</value>
 230         <remarks>
 231           <attribution license="cc4" from="Microsoft" modified="false" />
 232           <para>The <see cref="P:System.Net.Configuration.SmtpNetworkElement.TargetName" /> property allows an application to get or set the SPN to use for authentication when integrated Windows authentication with extended protection. If the <see cref="P:System.Net.Configuration.SmtpNetworkElement.TargetName" /> property is not set, the default value for this SPN is of the form "SMTPSVC/&lt;host&gt;" where &lt;host&gt; is the hostname of the SMTP mail server. </para>
 233           <para>The default value for this network element in the SMTP configuration file can also be changed by manually editing the machine or application configuration files directly.</para>
 234         </remarks>
 235         <summary>
 236           <attribution license="cc4" from="Microsoft" modified="false" />
 237           <para>Gets or sets the Service Provider Name (SPN) to use for authentication when using extended protection to connect to an SMTP mail server.</para>
 238         </summary>
 239       </Docs>
 240     </Member>
 241     <Member MemberName="UserName">
 242       <MemberSignature Language="C#" Value="public string UserName { get; set; }" />
 243       <MemberSignature Language="ILAsm" Value=".property instance string UserName" />
 244       <MemberType>Property</MemberType>
 245       <AssemblyInfo>
 246         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 247         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 248       </AssemblyInfo>
 249       <Attributes>
 250         <Attribute>
 251           <AttributeName>System.Configuration.ConfigurationProperty("userName", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
 252         </Attribute>
 253       </Attributes>
 254       <ReturnValue>
 255         <ReturnType>System.String</ReturnType>
 256       </ReturnValue>
 257       <Docs>
 258         <value>To be added.</value>
 259         <since version=".NET 2.0" />
 260         <remarks>
 261           <attribution license="cc4" from="Microsoft" modified="false" />
 262           <para>Setting <see cref="P:System.Net.Configuration.SmtpNetworkElement.DefaultCredentials" /> takes precedence over setting <see cref="P:System.Net.Configuration.SmtpNetworkElement.UserName" /> and <see cref="P:System.Net.Configuration.SmtpNetworkElement.Password" />. <see cref="P:System.Net.Configuration.SmtpNetworkElement.UserName" /> and <see cref="P:System.Net.Configuration.SmtpNetworkElement.Password" /> are used only if <see cref="P:System.Net.Configuration.SmtpNetworkElement.DefaultCredentials" /> is set to false.</para>
 263         </remarks>
 264         <summary>
 265           <attribution license="cc4" from="Microsoft" modified="false" />
 266           <para>Gets or sets the user name to connect to an SMTP mail server.</para>
 267         </summary>
 268       </Docs>
 269     </Member>
 270   </Members>
 271 </Type>