MailMessage.To Property (System.Net.Mail)

To 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

MailMessage..::.To Property

Gets the address collection that contains the recipients of this e-mail message.

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

Syntax

Visual Basic (Declaration)

Public ReadOnly Property To As MailAddressCollection

Visual Basic (Usage)

Dim instance As MailMessage
Dim value As MailAddressCollection

value = instance.To

public MailAddressCollection To { get; }

Visual C++

public:
property MailAddressCollection^ To {
    MailAddressCollection^ get ();
}

JScript

public function get To () : MailAddressCollection

Property Value

Type: System.Net.Mail..::.MailAddressCollection
A writable MailAddressCollection object.

Remarks

The To property is used to designate the addresses on the To line of an e-mail message. To add a recipient to an e-mail message, create a MailAddress for the recipient's address, and then add that object to the collection returned by this property.

Examples

The following code example demonstrates setting the To property.

        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

MailMessage Class

MailMessage Members

System.Net.Mail Namespace

Tags

: Add a tag

Flag as ContentBug

SMTP Sample using PowerShell

Thomas Lee | Edit | Show History

# Send-SMTPMessage.ps1

# MSDN Sample, recoded using PowerShell

# Thomas Lee - tfl@psp.co.uk

# Create from/to addresses

$from = New-Object system.net.mail.MailAddress "powershell@psp.co.uk"

$to = New-Object system.net.mail.MailAddress tfl@psp.co.uk

# Create Message

$message = new-object system.net.mail.MailMessage $from, $to

$message.Subject = "Using the SmtpClient class and PowerShell"

$message.Body = @"

Using this feature, you can send an e-mail message from an application very easily.

"@

# Set SMTP Server and create SMTP Client

$server = "localhost"

$client = new-object system.net.mail.smtpclient $server

# SO do it

"Sending an e-mail message to {0} by using SMTP host {1} port {2}." -f $to.ToString(), $client.Host, $client.Port

try {

$client.Send($message)

catch {

"Exception caught in CreateTestMessage: {0}" -f $Error.ToString()

This script produces the following output:

C:\foo> .\send-smtpmessage.ps1

Sending an e-mail message to tfl by using SMTP host localhost  port 25