menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MIMEDocument - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class MIMEDocument

    Represents MIME documents.

    Inheritance
    System.Object
    MIMEDocument
    Implements
    IMIMEDocument
    IMIMESerialization
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Syncfusion.MIME
    Assembly: Syncfusion.MIME.Base.dll
    Syntax
    public class MIMEDocument : IMIMEDocument, IMIMESerialization

    Constructors

    MIMEDocument()

    document constructor

    Declaration
    public MIMEDocument()

    Properties

    DocumentEncoding

    get/set document encoding

    Declaration
    public Encoding DocumentEncoding { get; set; }
    Property Value
    Type
    System.Text.Encoding

    Header

    property to get document header

    Declaration
    public IMIMEDocumentHeader Header { get; }
    Property Value
    Type
    IMIMEDocumentHeader

    MessagePart

    property to get message part

    Declaration
    public IMIMEPart MessagePart { get; }
    Property Value
    Type
    IMIMEPart

    MessageParts

    Declaration
    public IMIMEBoundaryPart MessageParts { get; }
    Property Value
    Type
    IMIMEBoundaryPart

    MixedParts

    property to get parts collection

    Declaration
    public IMIMEPartsCollection MixedParts { get; }
    Property Value
    Type
    IMIMEPartsCollection

    Parts

    property to get parts collection

    Declaration
    public IMIMEPartsCollection Parts { get; }
    Property Value
    Type
    IMIMEPartsCollection

    Methods

    AppendString(String)

    Method used to appent text to message part with string.

    Declaration
    public void AppendString(string text)
    Parameters
    Type Name Description
    System.String text

    text to append .

    AppendText(Stream)

    Method used to appent text to message part from stream.

    Declaration
    public void AppendText(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    stream to read from.

    AppendText(String)

    Method used to appent text to message part from file.

    Declaration
    public void AppendText(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    path to the file.

    AppendText(String, Encoding)

    Method used to appent text to message part from file with specified encoding.

    Declaration
    public void AppendText(string filePath, Encoding encoding)
    Parameters
    Type Name Description
    System.String filePath

    path to file.

    System.Text.Encoding encoding

    encoding to use in file reading.

    AttachBinary(Stream)

    Method used to attach binary data to document from stream.

    Declaration
    public IMIMEPart AttachBinary(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    stream to read from.

    Returns
    Type Description
    IMIMEPart

    interface of attached part.

    AttachBinary(String)

    Method used to attach binary data to document from file

    Declaration
    public IMIMEPart AttachBinary(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    path to file

    Returns
    Type Description
    IMIMEPart

    interface of attached part

    ConvertHTML(String)

    method to convert html to MIME.

    Declaration
    public IMIMEDocument ConvertHTML(string fileToRead)
    Parameters
    Type Name Description
    System.String fileToRead

    path to file to convert.

    Returns
    Type Description
    IMIMEDocument

    MIME document.

    EmbedData(Stream)

    Method to add embeded data to document. from stream

    Declaration
    public IMIMEPart EmbedData(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    stream to read from.

    Returns
    Type Description
    IMIMEPart

    embedded part interface.

    EmbedData(String)

    Method to add embeded data to document from file.

    Declaration
    public IMIMEPart EmbedData(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    path to file.

    Returns
    Type Description
    IMIMEPart

    embedded part interface.

    GetAllParts()

    method to get all parts of document.

    Declaration
    public IMIMEPartsCollection GetAllParts()
    Returns
    Type Description
    IMIMEPartsCollection

    parts collection.

    GetDigest()

    Method to create digest part.

    Declaration
    public IMIMEBoundaryPart GetDigest()
    Returns
    Type Description
    IMIMEBoundaryPart

    digest part interface.

    Load(Stream)

    mathod to load document.

    Declaration
    public void Load(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    stream to read from.

    Load(String)

    Loads MIME document from file.

    Declaration
    public void Load(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    path to file.

    Parse(String)

    static method to load document

    Declaration
    public static IMIMEDocument Parse(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    path to file

    Returns
    Type Description
    IMIMEDocument

    MIMEDocument

    Reset()

    Reset document.

    Declaration
    public void Reset()

    Save(Stream)

    Method to save current document to stream.

    Declaration
    public void Save(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    stream to save to.

    Save(StreamWriter)

    Save MIME document to stream.

    Declaration
    public void Save(StreamWriter stream)
    Parameters
    Type Name Description
    System.IO.StreamWriter stream

    stream to write to.

    Save(String)

    Method to save current document to file.

    Declaration
    public void Save(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    path to file to write.

    Implements

    IMIMEDocument
    IMIMESerialization
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved