SmtpClient.Host Property (System.Net.Mail)

Host Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

SmtpClient..::.Host Property

Gets or sets the name or IP address of the host used for SMTP transactions.

Namespace: System.Net.Mail
Assembly: System (in System.dll)

Syntax

Visual Basic (Declaration)

Public Property Host As String

Visual Basic (Usage)

Dim instance As SmtpClient
Dim value As String

value = instance.Host

instance.Host = value

public string Host { get; set; }

Visual C++

public:
property String^ Host {
    String^ get ();
    void set (String^ value);
}

JScript

public function get Host () : String
public function set Host (value : String)

Property Value

Type: System..::.String
A String that contains the name or IP address of the computer to use for SMTP transactions.

Exceptions

Exception	Condition
ArgumentNullException	The value specified for a set operation is nullNothingnullptra null reference (Nothing in Visual Basic).
ArgumentException	The value specified for a set operation is equal to String..::.Empty ("").
InvalidOperationException	You cannot change the value of this property when an email is being sent.

Remarks

The value of the Host property can also be set using constructors or the application or machine configuration file. For more information, see <mailSettings> Element (Network Settings).

If information is specified using this property, this information overrides the configuration file settings.

Examples

The following code example demonstrates sending an e-mail message by using the host and port specified in an application configuration file.

        public static void CreateTestMessage4(string server)
        {
            MailAddress from = new MailAddress("ben@contoso.com");
            MailAddress to = new MailAddress("Jane@contoso.com");
            MailMessage message = new MailMessage(from, to);
            message.Subject = "Using the SmtpClient class.";
            message.Body = @"Using this feature, you can send an e-mail message from an application very easily.";
            SmtpClient client = new SmtpClient(server);
            Console.WriteLine("Sending an e-mail message to {0} by using SMTP host {1} port {2}.",
                 to.ToString(), client.Host, client.Port);

      try {
              client.Send(message);
            }
            catch (Exception ex) {
              Console.WriteLine("Exception caught in CreateTestMessage4(): {0}", 
                    ex.ToString() );              
          }
        }

Visual C++

static void CreateTestMessage4( String^ server )
{
   MailAddress^ from = gcnew MailAddress( L"ben@contoso.com" );
   MailAddress^ to = gcnew MailAddress( L"Jane@contoso.com" );
   MailMessage^ message = gcnew MailMessage( from,to );
   message->Subject = L"Using the SmtpClient class.";
   message->Body = L"Using this feature, you can send an e-mail message from an application very easily.";
   SmtpClient^ client = gcnew SmtpClient( server );
   Console::WriteLine( L"Sending an e-mail message to {0} by using SMTP host {1} port {2}.", to, client->Host, client->Port );
   client->Send( message );
   client->~SmtpClient();
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

SmtpClient Class

SmtpClient Members

System.Net.Mail Namespace

Port