This documentation is archived and is not being maintained.

MailAddress.DisplayName Property

Note: This property is new in the .NET Framework version 2.0.

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)

public string DisplayName { get; }
/** @property */
public String get_DisplayName ()

public function get DisplayName () : String

Property Value

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

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.

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());
    client.Send(message);
}

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

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

.NET Framework

Supported in: 2.0
Show: