MailAddress.DisplayName Property (System.Net.Mail)

DisplayName 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

MailAddress..::.DisplayName Property

Gets the display name composed from the display name and address information specified when this instance was created.

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

Syntax

Visual Basic (Declaration)

Public ReadOnly Property DisplayName As String

Visual Basic (Usage)

Dim instance As MailAddress
Dim value As String

value = instance.DisplayName

public string DisplayName { get; }

Visual C++

public:
property String^ DisplayName {
    String^ get ();
}

JScript

public function get DisplayName () : String

Property Value

Type: System..::.String
A String that contains the display name; otherwise, String..::.Empty ("") if no display name information was specified when this instance was created.

Remarks

Display names that contain non-ASCII characters are returned in human-readable form. Use the ToString method to get the encoded form of the DisplayName.

Some software programs that are used to read e-mail display the DisplayName property value instead of, or in addition to, the e-mail address.

Examples

The following code example displays the DisplayName for the recipient of an e-mail message.

        public static void CreateBccTestMessage(string server)
        {
            MailAddress from = new MailAddress("ben@contoso.com", "Ben Miller");
            MailAddress to = new MailAddress("jane@contoso.com", "Jane Clayton");
            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.";
            MailAddress bcc = new MailAddress("manager1@contoso.com");
            message.Bcc.Add(bcc);
            SmtpClient client = new SmtpClient(server);
            client.Credentials = CredentialCache.DefaultNetworkCredentials;
            Console.WriteLine("Sending an e-mail message to {0} and {1}.", 
                to.DisplayName, message.Bcc.ToString());
      try {
        client.Send(message);
      }  
      catch (Exception ex) {
        Console.WriteLine("Exception caught in CreateBccTestMessage(): {0}", 
                    ex.ToString() );
        }
      }

Visual C++

static void CreateBccTestMessage( String^ server )
{
   MailAddress^ from = gcnew MailAddress( L"ben@contoso.com",L"Ben Miller" );
   MailAddress^ to = gcnew MailAddress( L"jane@contoso.com",L"Jane Clayton" );
   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.";
   MailAddress^ bcc = gcnew MailAddress( L"manager1@contoso.com" );
   message->Bcc->Add( bcc );
   SmtpClient^ client = gcnew SmtpClient( server );
   client->Credentials = CredentialCache::DefaultNetworkCredentials;
   Console::WriteLine( L"Sending an e-mail message to {0} and {1}.", to->DisplayName, message->Bcc );
   try
   { 
       client->Send( message );
   }
   catch ( Exception^ ex )
   {
       Console::WriteLine(L"Exception caught in CreateBccTestMessage(): {0}", 
                     ex->ToString() );
   }
   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

MailAddress Class

MailAddress Members

System.Net.Mail Namespace