MIME Component

Properties   Methods   Events   Config Settings   Errors  

The MIME component allows for the simple encoding and decoding of MIME structures, such as message attachments and file uploads.

Syntax

nsoftware.IPWorksOpenPGP.Mime

Remarks

The component may be used for decoding or encoding of messages. Message holds the content of the encoded message or the filename that holds the encoded data. The decoded data are provided in Parts collection.

To decode a MIME message, you should first assign either the whole message (headers and body) to Message or put the message headers into the MessageHeaders property and the message body or the filename holding it into the Message property. Calling DecodeFromFile or DecodeFromString directs the component to start parsing the message: it will fill out the ContentType and ContentTypeAttr properties with message content-type information, and it will enter information about message parts into the Parts collection, which includes part sizes, part content types, part content type attributes, part content disposition, part content disposition attributes, part encoding, part name, part filename, part headers, or part content (part-decoded string or part-decoded file) for each decoded part.

Calling the DecodeFromString or DecodeFromFile to decode does not actually decode the message but only parses it. The real decoding is done when the part content in the Parts collection is first accessed.

To encode data into a MIME message, you should first assign values for each part to either a part-decoded string or a part- decoded file in the Parts collection property, and optionally assign values to the other part attributes in the Parts collection. Assigning a value to the part-decoded string or a part-decoded file through the Parts collection, fills out automatically the part headers into the Parts collection for the respective part. Calling EncodeToFile or EncodeToString directs the component to fill out the Message with the message body and the MessageHeaders with the headers.

The Progress event is fired as the message is parsed and the data are decoded/encoded.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Boundary Property (MIME Component)

This property includes the boundary separating the MIME parts. It has a maximum length of 80 bytes.

Syntax

• C#
• VB.NET

public string Boundary { get; set; }

Public Property Boundary As String

Default Value

""

Remarks

This property contains the boundary separating the MIME parts and has a maximum length of 80 bytes. The component automatically generates a random boundary value during encoding, if no value is given. During decoding, this property is filled with the boundary from the actual MIME message.

The component will truncate any string longer than 80 bytes if assigned to Boundary.

ContentType Property (MIME Component)

This property includes the value of the content-type header of the message that was encoded/decoded.

Syntax

• C#
• VB.NET

public string ContentType { get; set; }

Public Property ContentType As String

Default Value

""

Remarks

This property contains the value of the content-type header of the message that was encoded/decoded. The component filters it out from the MessageHeaders. It shows the user information about the type of the parts and their relation to each other.

The content-type attributes, such as filename, boundary, and charset, are held in this property.

ContentTypeAttr Property (MIME Component)

This property includes the attributes of the content-type header of the message that was encoded or decoded.

Syntax

• C#
• VB.NET

public string ContentTypeAttr { get; set; }

Public Property ContentTypeAttr As String

Default Value

""

Remarks

This property contains content-type attributes such as "filename", "boundary", and "charset".

Message Property (MIME Component)

This property contains the encoded message text or a path to a file that contains the encoded message text.

Syntax

• C#
• VB.NET

public string Message { get; set; }
public byte[] MessageB { get; set; }

Public Property Message As String
Public Property MessageB As Byte()

Default Value

""

Remarks

This property contains the encoded message text or a path to a file that contains the encoded message text. The component fills out this property with the message body and MessageHeaders during encoding. The user may assign both the headers and the body to this property and leave MessageHeaders empty before decoding.

This property is not available at design time.

MessageHeaders Property (MIME Component)

This property includes the headers of the MIME message.

Syntax

• C#
• VB.NET

public HeaderList MessageHeaders { get; }

Public Property MessageHeaders As HeaderList

Remarks

This property contains the headers of the MIME message. The component fills out this property upon encoding. The user should use them as additional headers when emailing the Message.

During decoding, if this property is empty, the component will try to find the headers in the beginning of the Message and then will fill out this property accordingly.

MessageHeadersString Property (MIME Component)

This property includes the string version of the MIME message headers.

Syntax

• C#
• VB.NET

public string MessageHeadersString { get; set; }

Public Property MessageHeadersString As String

Default Value

""

Remarks

The component fills out MessageHeadersString upon encoding. The user should use these strings as additional headers when emailing the Message.

This property contains a string version of the MIME message headers. During decoding, if this property is empty, the component will try to find the headers in the beginning of the Message and will fill out this property accordingly.

Parts Property (MIME Component)

This property contains information about all parts of a MIME message.

Syntax

• C#
• VB.NET

public MIMEPartList Parts { get; }

Public Property Parts As MIMEPartList

Remarks

This property contains information about all parts of a MIME message. A MIME message consists of different parts, separated by either a user-specified or an auto-generated boundary. Each part has its own set of headers that are contained in the Headers field.

The MIMEPARTS collection is filled out by the component when a call to either DecodeFromFile or DecodeFromString is made. However, when the EncodeToFile or EncodeToString methods are called, the component encodes the data given in either DecodedFile or DecodedString into a MIME message.

This collection is indexed from 0 to count -1.

Config Method (MIME Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DecodeFromFile Method (MIME Component)

This method decodes from a file.

Syntax

• C#
• VB.NET

public void DecodeFromFile();

Async Version
public async Task DecodeFromFile();
public async Task DecodeFromFile(CancellationToken cancellationToken);

Public Sub DecodeFromFile()

Async Version
Public Sub DecodeFromFile() As Task
Public Sub DecodeFromFile(cancellationToken As CancellationToken) As Task

Remarks

This method decodes the data file given in Message and optionally MessageHeaders and fills out the Parts collection for each decoded part.

Example. Decoding from a File:

MIMEControl.Message = "C:\filename.txt" MIMEControl.DecodeFromFile

In this example, C:\filename.txt must contain the MIME headers and body. If not, the MessageHeaders property must be set to the appropriate MIME headers.

DecodeFromStream Method (MIME Component)

This method decodes from a stream.

Syntax

• C#
• VB.NET

public void DecodeFromStream(System.IO.Stream inputStream);

Async Version
public async Task DecodeFromStream(System.IO.Stream inputStream);
public async Task DecodeFromStream(System.IO.Stream inputStream, CancellationToken cancellationToken);

Public Sub DecodeFromStream(ByVal InputStream As System.IO.Stream)

Async Version
Public Sub DecodeFromStream(ByVal InputStream As System.IO.Stream) As Task
Public Sub DecodeFromStream(ByVal InputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method decodes from a stream. It is the same as DecodeFromString, but now the MIME message is passed to this method as a stream.

This method decodes the data given by the InputStream and optionally MessageHeaders and fills out the Parts collection.

Example. Decoding a Mail Message:

MIMEControl.MessageHeaders.AddRange(MailControl.MessageHeaders) MIMEControl.DecodeFromStream(InputStream)

DecodeFromString Method (MIME Component)

This method decodes from a string.

Syntax

• C#
• VB.NET

public void DecodeFromString();

Async Version
public async Task DecodeFromString();
public async Task DecodeFromString(CancellationToken cancellationToken);

Public Sub DecodeFromString()

Async Version
Public Sub DecodeFromString() As Task
Public Sub DecodeFromString(cancellationToken As CancellationToken) As Task

Remarks

This method decodes from a string. It is the same as DecodeFromFile, but now the Message denotes the real encoded message rather than a filename.

This method decodes the data given in Message and optionally MessageHeaders and fills out the Parts collection.

Example. Decoding a Mail Message:

MIMEControl.MessageHeaders.AddRange(MailControl.MessageHeaders) MIMEControl.Message = MailControl.MessageText MIMEControl.DecodeFromString

DecodePart Method (MIME Component)

This method decodes the specified part.

Syntax

• C#
• VB.NET

public byte[] DecodePart(int index);

Async Version
public async Task<byte[]> DecodePart(int index);
public async Task<byte[]> DecodePart(int index, CancellationToken cancellationToken);

Public Function DecodePart(ByVal index As Integer) As String

Async Version
Public Function DecodePart(ByVal index As Integer) As Task(Of String)
Public Function DecodePart(ByVal index As Integer, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method decodes the part specified by Index and returns the decoded part data.

DecodeFromString or DecodeFromFile must be called before calling this method. Calling this method will return the decoded bytes, and in addition, the DecodedString field will be populated with the string representation of the decoded data.

Example. Decoding a Specified Part:mime.MessageHeadersString = myMessageHeaders; mime.Message = myMessageBody; mime.DecodeFromString(); byte[] myPartContent = await mime.DecodePart(0);

DecodePartToFile Method (MIME Component)

This method decodes the specified part to a file on disk.

Syntax

• C#
• VB.NET

public string DecodePartToFile(int index);

Async Version
public async Task<string> DecodePartToFile(int index);
public async Task<string> DecodePartToFile(int index, CancellationToken cancellationToken);

Public Function DecodePartToFile(ByVal index As Integer) As String

Async Version
Public Function DecodePartToFile(ByVal index As Integer) As Task(Of String)
Public Function DecodePartToFile(ByVal index As Integer, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method decodes the part specified by Index to a temporary file. The full path to the temporary file is returned by this method. The user is responsible for deleting the temporary file.

DecodeFromString or DecodeFromFile must be called before calling this method.

DecodePartToStream Method (MIME Component)

This method decodes the specified part to a stream.

Syntax

• C#
• VB.NET

public void DecodePartToStream(int index, System.IO.Stream outputStream);

Async Version
public async Task DecodePartToStream(int index, System.IO.Stream outputStream);
public async Task DecodePartToStream(int index, System.IO.Stream outputStream, CancellationToken cancellationToken);

Public Sub DecodePartToStream(ByVal index As Integer, ByVal OutputStream As System.IO.Stream)

Async Version
Public Sub DecodePartToStream(ByVal index As Integer, ByVal OutputStream As System.IO.Stream) As Task
Public Sub DecodePartToStream(ByVal index As Integer, ByVal OutputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method decodes the part specified by Index to a stream specified by OutputStream.

DecodeFromString or DecodeFromFile must be called before calling this method.

EncodeToFile Method (MIME Component)

This method encodes to a file.

Syntax

• C#
• VB.NET

public void EncodeToFile();

Async Version
public async Task EncodeToFile();
public async Task EncodeToFile(CancellationToken cancellationToken);

Public Sub EncodeToFile()

Async Version
Public Sub EncodeToFile() As Task
Public Sub EncodeToFile(cancellationToken As CancellationToken) As Task

Remarks

This method encodes the data given in Parts collection (either a decoded file or a decoded string) into a MIME message at Message and MessageHeaders using the values optionally given in Parts collection. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts collection.

The component will check for each item in Parts collection (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be saved in the file pointed to by Message; the message headers will be held by MessageHeaders.

Example. Encoding Data:

MIMEControl.ResetData() MIMEControl.Parts.Add(new MIMEPart()) MIMEControl.Parts.Add(new MIMEPart()) MIMEControl.Parts[0].DecodedString = "This is plain text data" MIMEControl.Parts[0].Encoding = peQuotedPrintable MIMEControl.Parts[0].ContentType = "text/plain" MIMEControl.Parts[1].DecodedFile = "C:\filename.txt" MIMEControl.Message = "temp.tmp" MIMEControl.EncodeToFile()

EncodeToStream Method (MIME Component)

This method encodes to a stream.

Syntax

• C#
• VB.NET

public void EncodeToStream(System.IO.Stream outputStream);

Async Version
public async Task EncodeToStream(System.IO.Stream outputStream);
public async Task EncodeToStream(System.IO.Stream outputStream, CancellationToken cancellationToken);

Public Sub EncodeToStream(ByVal OutputStream As System.IO.Stream)

Async Version
Public Sub EncodeToStream(ByVal OutputStream As System.IO.Stream) As Task
Public Sub EncodeToStream(ByVal OutputStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method encodes to a stream. It is the same as EncodeToString, but the encoded data are written to a stream instead of to the Message property.

This method encodes the data given in Parts collection into a MIME message. The Message gets written to the specified OutputStream and MessageHeaders using the values optionally given in the Parts collection. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts collection by calling ResetData.

The component will check each item in the Parts collection (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be written to the specified OutputStream, and the message headers will be held by MessageHeaders.

Example. Encoding Data:

MIMEControl.ResetData() MIMEControl.Parts.Add(new MIMEPart()) MIMEControl.Parts.Add(new MIMEPart()) MIMEControl.Parts[0].DecodedString = "This is plain text data" MIMEControl.Parts[0].Encoding = peQuotedPrintable MIMEControl.Parts[0].ContentType = "text/plain" MIMEControl.Parts[1].DecodedFile = "C:\filename.txt" MIMEControl.EncodeToStream(OutputStream)

EncodeToString Method (MIME Component)

This method encodes to a string.

Syntax

• C#
• VB.NET

public void EncodeToString();

Async Version
public async Task EncodeToString();
public async Task EncodeToString(CancellationToken cancellationToken);

Public Sub EncodeToString()

Async Version
Public Sub EncodeToString() As Task
Public Sub EncodeToString(cancellationToken As CancellationToken) As Task

Remarks

This method encodes to a string. It is the same as EncodeToFile but the encoded data are held in the Message property rather than saved to a file.

This method encodes the data given in the Parts collection into a MIME message. The message gets stored in Message and MessageHeaders using the values optionally given in Parts collection. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts collection by calling ResetData.

The component will check each item in the Parts collection (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be stored in the Message property; the message headers will be held by MessageHeaders.

Example. Encoding Data:

MIMEControl.ResetData() MIMEControl.Parts.Add(new MIMEPart()) MIMEControl.Parts.Add(new MIMEPart()) MIMEControl.Parts[0].DecodedString = "This is plain text data" MIMEControl.Parts[0].Encoding = peQuotedPrintable MIMEControl.Parts[0].ContentType = "text/plain" MIMEControl.Parts[1].DecodedFile = "C:\filename.txt" MIMEControl.EncodeToString()

Reset Method (MIME Component)

Reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

ResetData Method (MIME Component)

This method resets the values of all headers and part properties.

Syntax

• C#
• VB.NET

public void ResetData();

Async Version
public async Task ResetData();
public async Task ResetData(CancellationToken cancellationToken);

Public Sub ResetData()

Async Version
Public Sub ResetData() As Task
Public Sub ResetData(cancellationToken As CancellationToken) As Task

Remarks

This method resets the values of all headers and part properties. It is an easy way to reset the component's properties before starting to populate the part properties with new values.

Error Event (MIME Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, MimeErrorEventArgs e);

public class MimeErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As MimeErrorEventArgs)

Public Class MimeErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (MIME Component)

This event is fired every time a header is parsed.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, MimeHeaderEventArgs e);

public class MimeHeaderEventArgs : EventArgs {
  public int PartIndex { get; }
  public string Field { get; }
  public string Value { get; }
  public byte[] ValueB { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As MimeHeaderEventArgs)

Public Class MimeHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property PartIndex As Integer
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
  Public ReadOnly Property ValueB As Byte()
End Class

Remarks

The PartIndex parameter contains the index of the part containing the current header. If the header is from the MIME body, this value will be -1. The Field parameter contains the name of the MIME header. The Value parameter contains the header contents. The Header event is fired when a header is parsed, which occurs for each header of the message when DecodeFromFile, DecodeFromString, or DecodeFromStream is called.

Progress Event (MIME Component)

This event shows the progress of decoding or encoding the input data.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, MimeProgressEventArgs e);

public class MimeProgressEventArgs : EventArgs {
  public int PercentDone { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As MimeProgressEventArgs)

Public Class MimeProgressEventArgs Inherits EventArgs
  Public ReadOnly Property PercentDone As Integer
End Class

Remarks

The Progress allows the user to visualize the progress of processing the input data.

The PercentDone parameter shows what percentage of the input has been read.

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

MIMEPart Type

This is a part of the MIME message.

Remarks

Each MIME message is split into parts. A message must have at least one part to be a valid MIME message. The message itself is split into the MessageHeaders and the Message body. The body is then split into MIME parts by a specified or generated Boundary. Each part of a MIME message has its own Headers as well. These headers describe the MIMEPart and its contents.

The decoded data will be held in DecodedString or otherwise will be saved in a temporary file given by DecodedFile when the user asks for the value of the respective field.

If the encoded data are file data, the decoded file(s) will be given in the DecodedFile field. Otherwise, the decoded data will be in the DecodedString field.

When the EncodeToString method is called, the component will check for each item in the Parts collection (first the DecodedFile and then the DecodedString) for the data to encode.

Fields

Constructors

• C#
• VB.NET

public MIMEPart();

Public MIMEPart()

• C#
• VB.NET

public MIMEPart(string decodedFile);

Public MIMEPart(ByVal DecodedFile As String)

• C#
• VB.NET

public MIMEPart(byte[] decodedString);

Public MIMEPart(ByVal DecodedString As Byte())

• C#
• VB.NET

public MIMEPart(System.IO.Stream partInputStream);

Public MIMEPart(ByVal PartInputStream As System.IO.Stream)

• C#
• VB.NET

public MIMEPart(System.IO.Stream partInputStream, string encoding);

Public MIMEPart(ByVal PartInputStream As System.IO.Stream, ByVal Encoding As String)

Config Settings (MIME Component)

MIME Config Settings

Base Config Settings

Trappable Errors (MIME Component)

MIME Errors