linux-packaging-mono/mcs/class/System/Documentation/en/System.Net.Mail/Attachment.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="Attachment" FullName="System.Net.Mail.Attachment">
  <TypeSignature Language="C#" Value="public class Attachment : System.Net.Mail.AttachmentBase" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Attachment extends System.Net.Mail.AttachmentBase" />
  <AssemblyInfo>
    <AssemblyName>System</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Net.Mail.AttachmentBase</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Net.Mail.Attachment" /> class is used with the <see cref="T:System.Net.Mail.MailMessage" /> class. All messages include a <see cref="P:System.Net.Mail.MailMessage.Body" />, which contains the content of the message. In addition to the body, you might want to send additional files. These are sent as attachments and are represented as <see cref="T:System.Net.Mail.Attachment" /> instances. To add an attachment to a mail message, add it to the <see cref="P:System.Net.Mail.MailMessage.Attachments" /> collection.</para>
      <para>Attachment content can be a <see cref="T:System.String" />, <see cref="T:System.IO.Stream" />, or file name. You can specify the content in an attachment by using any of the <see cref="Overload:System.Net.Mail.Attachment.#ctor" /> constructors.</para>
      <para>The MIME Content-Type header information for the attachment is represented by the <see cref="P:System.Net.Mail.AttachmentBase.ContentType" /> property. The Content-Type header specifies the media type and subtype and any associated parameters. Use <see cref="P:System.Net.Mail.AttachmentBase.ContentType" /> to get the instance associated with an attachment.</para>
      <para>The MIME Content-Disposition header is represented by the <see cref="P:System.Net.Mail.Attachment.ContentDisposition" /> property. The Content-Disposition header specifies the presentation and file time stamps for an attachment. A Content-Disposition header is sent only if the attachment is a file. Use the <see cref="P:System.Net.Mail.Attachment.ContentDisposition" /> property to get the instance associated with an attachment.</para>
      <para>The MIME Content-Transfer-Encoding header is represented by the <see cref="P:System.Net.Mail.AttachmentBase.TransferEncoding" /> property.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents an attachment to an e-mail.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Attachment (string fileName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fileName) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="fileName" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The properties are set as follows: </para>
          <list type="table">
            <listheader>
              <item>
                <term>
                  <para>Property</para>
                </term>
                <description>
                  <para>Value</para>
                </description>
              </item>
            </listheader>
            <item>
              <term>
                <para>
                  <see cref="P:System.Net.Mime.ContentType.MediaType" />
                </para>
              </term>
              <description>
                <para>
                  <see cref="F:System.Net.Mime.MediaTypeNames.Text.Plain" />.</para>
              </description>
            </item>
            <item>
              <term>
                <para>
                  <see cref="P:System.Net.Mail.AttachmentBase.TransferEncoding" />
                </para>
              </term>
              <description>
                <para>
                  <see cref="F:System.Net.Mime.TransferEncoding.QuotedPrintable" />.</para>
              </description>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Net.Mail.Attachment" /> class with the specified content string. </para>
        </summary>
        <param name="fileName">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains a file path to use to create this attachment.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Attachment (System.IO.Stream contentStream, System.Net.Mime.ContentType contentType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream contentStream, class System.Net.Mime.ContentType contentType) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="contentStream" Type="System.IO.Stream" />
        <Parameter Name="contentType" Type="System.Net.Mime.ContentType" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Net.Mail.AttachmentBase.TransferEncoding" /> property is set to <see cref="F:System.Net.Mime.TransferEncoding.Base64" />.</para>
          <para>If the stream's <see cref="P:System.IO.Stream.CanSeek" /> property is false, the attachment and the <see cref="T:System.Net.Mail.MailMessage" /> that contains it are not reusable. You must supply a stream that can be searched to reuse an attachment.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Net.Mail.Attachment" /> class with the specified stream and content type. </para>
        </summary>
        <param name="contentStream">
          <attribution license="cc4" from="Microsoft" modified="false" />A readable <see cref="T:System.IO.Stream" /> that contains the content for this attachment.</param>
        <param name="contentType">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Net.Mime.ContentType" /> that describes the data in <paramref name="stream" />.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Attachment (System.IO.Stream contentStream, string name);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream contentStream, string name) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="contentStream" Type="System.IO.Stream" />
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>If <paramref name="name" /> is not null or equal to <see cref="F:System.String.Empty" /> (""), the <see cref="T:System.Net.Mime.ContentType" /> for this attachment is constructed with the <see cref="P:System.Net.Mime.ContentType.Name" /> property set to <paramref name="name" />. The <see cref="P:System.Net.Mail.AttachmentBase.TransferEncoding" /> property is set to <see cref="F:System.Net.Mime.TransferEncoding.Base64" />.</para>
          <para>If the stream's <see cref="P:System.IO.Stream.CanSeek" /> property is false, the attachment and the <see cref="T:System.Net.Mail.MailMessage" /> that contains it are not reusable. You must supply a stream that can be searched in order to reuse an attachment.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Net.Mail.Attachment" /> class with the specified stream and name.</para>
        </summary>
        <param name="contentStream">
          <attribution license="cc4" from="Microsoft" modified="false" />A readable <see cref="T:System.IO.Stream" /> that contains the content for this attachment.</param>
        <param name="name">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the value for the <see cref="P:System.Net.Mime.ContentType.Name" /> property of the <see cref="T:System.Net.Mime.ContentType" /> associated with this attachment. This value can be null.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Attachment (string fileName, System.Net.Mime.ContentType contentType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fileName, class System.Net.Mime.ContentType contentType) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="fileName" Type="System.String" />
        <Parameter Name="contentType" Type="System.Net.Mime.ContentType" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Net.Mail.Attachment" /> class with the specified content string and <see cref="T:System.Net.Mime.ContentType" />.</para>
        </summary>
        <param name="fileName">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains a file path to use to create this attachment.</param>
        <param name="contentType">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Net.Mime.ContentType" /> that describes the data in <paramref name="string" />.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Attachment (string fileName, string mediaType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fileName, string mediaType) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="fileName" Type="System.String" />
        <Parameter Name="mediaType" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>If <paramref name="mediaType" /> is null or equal to <see cref="F:System.String.Empty" /> (""), the <see cref="P:System.Net.Mime.ContentType.MediaType" /> property for this attachment is set to <see cref="F:System.Net.Mime.MediaTypeNames.Text.Plain" />. If <paramref name="mediaType" /> is not null and is not a zero-length string, it is used to construct the <see cref="T:System.Net.Mime.ContentType" /> associated with this attachment.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Net.Mail.Attachment" /> class with the specified content string and MIME type information. </para>
        </summary>
        <param name="fileName">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the content for this attachment.</param>
        <param name="mediaType">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the MIME Content-Header information for this attachment. This value can be null.</param>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Attachment (System.IO.Stream contentStream, string name, string mediaType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream contentStream, string name, string mediaType) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="contentStream" Type="System.IO.Stream" />
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="mediaType" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>If <paramref name="mediaType" /> is not null or equal to <see cref="F:System.String.Empty" /> (""), it is used to construct the <see cref="T:System.Net.Mime.ContentType" /> class associated with this attachment.</para>
          <para>If <paramref name="mediaType" /> and <paramref name="name" /> both contain <see cref="P:System.Net.Mime.ContentType.Name" /> information, the value specified in <paramref name="name" /> is used. The <see cref="P:System.Net.Mail.AttachmentBase.TransferEncoding" /> property is set to <see cref="F:System.Net.Mime.TransferEncoding.Base64" />.</para>
          <para>If the stream's <see cref="P:System.IO.Stream.CanSeek" /> property is false, the attachment and the <see cref="T:System.Net.Mail.MailMessage" /> that contains it are not reusable. You must supply a stream that can be searched in order to reuse an attachment.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Net.Mail.Attachment" /> class with the specified stream, name, and MIME type information. </para>
        </summary>
        <param name="contentStream">
          <attribution license="cc4" from="Microsoft" modified="false" />A readable <see cref="T:System.IO.Stream" /> that contains the content for this attachment.</param>
        <param name="name">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the value for the <see cref="P:System.Net.Mime.ContentType.Name" /> property of the <see cref="T:System.Net.Mime.ContentType" /> associated with this attachment. This value can be null.</param>
        <param name="mediaType">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the MIME Content-Header information for this attachment. This value can be null.</param>
      </Docs>
    </Member>
    <Member MemberName="ContentDisposition">
      <MemberSignature Language="C#" Value="public System.Net.Mime.ContentDisposition ContentDisposition { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Mime.ContentDisposition ContentDisposition" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Mime.ContentDisposition</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The information in the <see cref="T:System.Net.Mime.ContentDisposition" /> class represents the MIME Content-Disposition header. This header is described in RFC 2183, available at <see cref="http://www.ietf.org/">http://www.ietf.org</see>.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the MIME content disposition for this attachment.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="CreateAttachmentFromString">
      <MemberSignature Language="C#" Value="public static System.Net.Mail.Attachment CreateAttachmentFromString (string content, System.Net.Mime.ContentType contentType);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.Mail.Attachment CreateAttachmentFromString(string content, class System.Net.Mime.ContentType contentType) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Mail.Attachment</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="content" Type="System.String" />
        <Parameter Name="contentType" Type="System.Net.Mime.ContentType" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates a mail attachment using the content from the specified string, and the specified <see cref="T:System.Net.Mime.ContentType" />.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An object of type <see cref="T:System.Net.Mail.Attachment" />.</para>
        </returns>
        <param name="content">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the content for this attachment.</param>
        <param name="contentType">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Net.Mime.ContentType" /> object that represents the Multipurpose Internet Mail Exchange (MIME) protocol Content-Type header to be used.</param>
      </Docs>
    </Member>
    <Member MemberName="CreateAttachmentFromString">
      <MemberSignature Language="C#" Value="public static System.Net.Mail.Attachment CreateAttachmentFromString (string content, string name);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.Mail.Attachment CreateAttachmentFromString(string content, string name) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Mail.Attachment</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="content" Type="System.String" />
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>If the content is in ASCII format then the character encoding is set to ASCII. For all other formats, the character encoding is set to utf-8. The default media type is plain text.</para>
          <para>If the content is not in ASCII format and the encoding is null, utf-8 encoding is used.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates a mail attachment using the content from the specified string, and the specified MIME content type name.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An object of type <see cref="T:System.Net.Mail.Attachment" />.</para>
        </returns>
        <param name="content">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the content for this attachment.</param>
        <param name="name">
          <attribution license="cc4" from="Microsoft" modified="false" />The MIME content type name value in the content type associated with this attachment.</param>
      </Docs>
    </Member>
    <Member MemberName="CreateAttachmentFromString">
      <MemberSignature Language="C#" Value="public static System.Net.Mail.Attachment CreateAttachmentFromString (string content, string name, System.Text.Encoding contentEncoding, string mediaType);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Net.Mail.Attachment CreateAttachmentFromString(string content, string name, class System.Text.Encoding contentEncoding, string mediaType) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Mail.Attachment</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="content" Type="System.String" />
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="contentEncoding" Type="System.Text.Encoding" />
        <Parameter Name="mediaType" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates a mail attachment using the content from the specified string, the specified MIME content type name, character encoding, and MIME header information for the attachment.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An object of type <see cref="T:System.Net.Mail.Attachment" />.</para>
        </returns>
        <param name="content">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the content for this attachment.</param>
        <param name="name">
          <attribution license="cc4" from="Microsoft" modified="false" />The MIME content type name value in the content type associated with this attachment.</param>
        <param name="contentEncoding">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Text.Encoding" />. This value can be null.</param>
        <param name="mediaType">
          <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.String" /> that contains the MIME Content-Header information for this attachment. This value can be null.</param>
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Name" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Net.Mail.Attachment.Name" /> property is used in the Content-Type header generated for this attachment. The <see cref="P:System.Net.Mail.Attachment.Name" /> is displayed as the attachment’s name when the email with the attachment is received. A grammar that details the syntax of the Content-Type header is described in RFC 2045 Section 5.1. RFC 2046 provides detailed information about MIME media types and their parameters. These RFCs are available at <see cref="http://www.ietf.org/">http://www.ietf.org</see>.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the MIME content type name value in the content type associated with this attachment.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="NameEncoding">
      <MemberSignature Language="C#" Value="public System.Text.Encoding NameEncoding { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Text.Encoding NameEncoding" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Text.Encoding</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Specifies the encoding for the <see cref="T:System.Net.Mail.Attachment" /> <see cref="P:System.Net.Mail.Attachment.Name" />.</para>
        </summary>
      </Docs>
    </Member>
  </Members>
</Type>