Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

164 lines
7.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="SmtpMail" FullName="System.Web.Mail.SmtpMail">
<TypeSignature Language="C#" Value="public class SmtpMail" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The mail message can be delivered either through the SMTP mail service built into Microsoft Windows 2000 or through an arbitrary SMTP server. Types in the <see cref="N:System.Web.Mail" /> namespace can be used from ASP.NET or from any managed application.</para>
<para>If the <see cref="P:System.Web.Mail.SmtpMail.SmtpServer" /> property is not set, mail is by default queued on a Windows 2000 system, ensuring that the calling program does not block network traffic. If the <see cref="T:System.Web.Mail.SmtpMail" /> property is set, the mail is delivered directly to the specified server.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides properties and methods for sending messages using the Collaboration Data Objects for Windows 2000 (CDOSYS) message component. Recommended alternative: <see cref="N:System.Net.Mail" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Send">
<MemberSignature Language="C#" Value="public static void Send (System.Web.Mail.MailMessage message);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="System.Web.Mail.MailMessage" />
</Parameters>
<Docs>
<remarks>
<para>
This method sends an e-mail to the recipients specified in the <see cref="T:System.Web.Mail.MailMessage" /> parameter
<paramref name="message" />. The e-mail is sent over the SMTP protocol through the server
specified in <see cref="P:System.Web.Mail.SmtpMail.SmtpServer" />.
</para>
<para>
This example shows the typical usage of the <c>SmtpMail.Send</c> method. To run this sample you have to change the
e-mail addresses and the SMTP server to real ones.
<example><code lang="C#">
using System;
using System.Web.Mail;
public class SmtpTest {
public static void Main (String[] args)
{
MailMessage message = new MailMessage();
message.From = "per@foo.bar";
message.To = "ola@foo.bar";
message.Subject = "Hello, E-Mail world!";
message.Body = "This is a test mail.";
SmtpMail.SmtpServer = "mail.foo.bar";
SmtpMail.Send (message);
}
}
</code></example></para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sends an e-mail message using arguments supplied in the properties of the <see cref="T:System.Web.Mail.MailMessage" /> class. Recommended alternative: <see cref="N:System.Net.Mail" />.</para>
</summary>
<param name="message">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.Mail.MailMessage" /> to send. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Send">
<MemberSignature Language="C#" Value="public static void Send (string from, string to, string subject, string messageText);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="from" Type="System.String" />
<Parameter Name="to" Type="System.String" />
<Parameter Name="subject" Type="System.String" />
<Parameter Name="messageText" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<para>
This is a method that sends an e-mail message over the SMTP protocol. It connects
to the SMTP server as specified in <see cref="P:System.Web.Mail.SmtpMail.SmtpServer" /> and
sends the e-mail to <paramref name="to" />. This method is a simplified version of
<see cref="M:System.Web.Mail.SmtpMail.Send(MailMessage)" /> which is actually used by this
method for sending e-mails.
</para>
<para>
Here is a simple example to show how to send an e-mail.
<example><code lang="C#">
using System;
using System.Web.Mail;
public class SmtpTest {
public static void Main (String[] args)
{
SmtpMail.SmtpServer = "mail.foo.bar";
SmtpMail.Send ("per@foo.bar","ola@foo.bar","Hello, E-Mail world!","This is a test mail.");
}
}
</code></example></para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sends an e-mail message using the specified destination parameters. Recommended alternative: <see cref="N:System.Net.Mail" />.</para>
</summary>
<param name="from">
<attribution license="cc4" from="Microsoft" modified="false" />The address of the e-mail sender. </param>
<param name="to">
<attribution license="cc4" from="Microsoft" modified="false" />The address of the e-mail recipient. </param>
<param name="subject">
<attribution license="cc4" from="Microsoft" modified="false" />The subject line of the e-mail message. </param>
<param name="messageText">
<attribution license="cc4" from="Microsoft" modified="false" />The body of the e-mail message. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SmtpServer">
<MemberSignature Language="C#" Value="public static string SmtpServer { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>A string representing the SMTP server address that the e-mails should be sent through.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If your local SMTP server (included with Windows 2000 and Windows Server 2003) is behind a firewall that blocks any direct SMTP traffic (through port 25), you will need to find out if there is a smart host available on your network that is allowed to relay SMTP messages to the Internet.</para>
<para>A smart host is an SMTP server with the permissions to relay outgoing e-mail messages directly to the Internet from internal SMTP servers. A smart host should be able to simultaneously connect to both the internal network and the Internet in order to work as the e-mail gateway.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the name of the SMTP relay mail server to use to send e-mail messages. Recommended alternative: <see cref="N:System.Net.Mail" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("The recommended alternative is System.Net.Mail.SmtpClient.")</AttributeName>
</Attribute>
</Attributes>
</Type>