ContentDisposition::Inline Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a Boolean value that determines the disposition type (Inline or Attachment) for an e-mail attachment.

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

public:
property bool Inline {
	bool get();
	void set(bool value);
}

Property Value

Type: System::Boolean

true if content in the attachment is presented inline as part of the e-mail body; otherwise, false.

The Inline property sets the disposition type in the Content-Disposition header sent with the e-mail message. The disposition type can be used by software that displays e-mail to determine the correct way to present the e-mail attachments. Attachments with a disposition type of DispositionTypeNames::Inline are usually displayed when the user opens the e-mail. Attachments with a disposition type of DispositionTypeNames::Attachment are usually not opened until the user performs some additional action, such as clicking an icon that represents the attachment.

The Content-Disposition header is described in RFC 2183 available at http://www.ietf.org.

The following code example demonstrates how to set the value of this property.

static void CreateMessageInlineAttachment( String^ server, String^ textMessage )
{

   // Create a message and set up the recipients.
   MailMessage^ message = gcnew MailMessage( L"jane@contoso.com",L"ben@contoso.com",L"An inline text message for you.",L"Message: " );

   // Attach the message string to this e-mail message.
   Attachment^ data = gcnew Attachment( textMessage,MediaTypeNames::Text::Plain );

   // Send textMessage as part of the e-mail body.
   message->Attachments->Add( data );
   ContentDisposition^ disposition = data->ContentDisposition;
   disposition->Inline = true;

   //Send the message.
   // Include credentials if the server requires them.
   SmtpClient^ client = gcnew SmtpClient( server );
   client->Credentials = CredentialCache::DefaultNetworkCredentials;
   client->Send( message );
   data->~Attachment();
   client->~SmtpClient();
}


.NET Framework
Available since 2.0
Return to top
Show: