SmtpClient.Host Property

Reference

Definition

Namespace:: System.Net.Mail

Assembly:: System.Net.Mail.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: SmtpClient.cs

Source:: SmtpClient.cs

Source:: SmtpClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

public string? Host { get; set; }

public string Host { get; set; }

member this.Host : string with get, set

Public Property Host As String

Property Value

String

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

Exceptions

ArgumentNullException

The value specified for a set operation is null.

ArgumentException

The value specified for a set operation is equal to Empty ("").

InvalidOperationException

You cannot change the value of this property when an email is being sent.

Examples

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

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 email message from an application very easily.";
   SmtpClient^ client = gcnew SmtpClient( server );
   Console::WriteLine( L"Sending an email message to {0} by using SMTP host {1} port {2}.", to, client->Host, client->Port );
   client->Send( message );
   client->~SmtpClient();
}

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 email message from an application very easily.";
    SmtpClient client = new SmtpClient(server);
    Console.WriteLine("Sending an email 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());
    }
}

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.

Applies to