Interface IMIMEDocument
MIME document interface.
Inherited Members
Namespace: Syncfusion.MIME
Assembly: Syncfusion.MIME.Base.dll
Syntax
public interface IMIMEDocument : IMIMESerialization
Properties
Header
Get reference on header of MIME document.
Declaration
IMIMEDocumentHeader Header { get; }
Property Value
Type |
---|
IMIMEDocumentHeader |
MessagePart
Get main document's part.
Declaration
IMIMEPart MessagePart { get; }
Property Value
Type |
---|
IMIMEPart |
MessageParts
gets main message parts.
Declaration
IMIMEBoundaryPart MessageParts { get; }
Property Value
Type |
---|
IMIMEBoundaryPart |
MixedParts
Get collection of MIME document parts.
Declaration
IMIMEPartsCollection MixedParts { get; }
Property Value
Type |
---|
IMIMEPartsCollection |
Parts
Get collection of MIME document parts.
Declaration
IMIMEPartsCollection Parts { get; }
Property Value
Type |
---|
IMIMEPartsCollection |
Methods
AppendString(String)
appends specified string .
Declaration
void AppendString(string text)
Parameters
Type | Name | Description |
---|---|---|
System.String | text | text to append |
AppendText(Stream)
Append text to MessagePart in MIME document.
Declaration
void AppendText(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | stream to append. |
AppendText(String)
Appends text from file to MIME document.
Declaration
void AppendText(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | Path to file. |
AppendText(String, Encoding)
Appending text to message.
Declaration
void AppendText(string filePath, Encoding encoding)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | Path to file |
System.Text.Encoding | encoding | Text file encoding. |
AttachBinary(Stream)
Create attachment in MIME document.
Declaration
IMIMEPart AttachBinary(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | stream to read from. |
Returns
Type | Description |
---|---|
IMIMEPart | generated part |
AttachBinary(String)
Create attachment in MIME document.
Declaration
IMIMEPart AttachBinary(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | file to add. |
Returns
Type | Description |
---|---|
IMIMEPart | generated part. |
ConvertHTML(String)
converting html document to MIME document.
Declaration
IMIMEDocument ConvertHTML(string fileToLoad)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileToLoad | path to HTML file |
Returns
Type | Description |
---|---|
IMIMEDocument | converted document. |
EmbedData(Stream)
Add embeded data to document from stream.
Declaration
IMIMEPart EmbedData(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | stream to read data from. |
Returns
Type | Description |
---|---|
IMIMEPart | generated part. |
EmbedData(String)
Add embeded data to document from file.
Declaration
IMIMEPart EmbedData(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | file path |
Returns
Type | Description |
---|---|
IMIMEPart | reference on created mime part object |
GetDigest()
Creates digest document.
Declaration
IMIMEBoundaryPart GetDigest()
Returns
Type | Description |
---|---|
IMIMEBoundaryPart | boundary part. |
Load(Stream)
Load MIME document from stream.
Declaration
void Load(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | stream to read from. |
Load(String)
Load MIME document from file.
Declaration
void Load(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | file path |
Reset()
Method to reset current document to null.
Declaration
void Reset()
Save(String)
Save MIME document to file.
Declaration
void Save(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | file path |