MailAddress.DisplayName Property

Definition

Namespace:

System.Net.Mail

Assemblies:

netstandard.dll, System.Net.Mail.dll

Source:

MailAddress.cs

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

C#

public string DisplayName { get; }

Property Value

String

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

Examples

The following code example displays the DisplayName for the recipient of an email message.

C#

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 email 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 email 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());
    }
}

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 email display the DisplayName property value instead of, or in addition to, the email address.

Applies to