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

TipwMIME

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 properties.

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 properties, 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 properties 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 properties property, and optionally assign values to the other part attributes in the Parts properties. Assigning a value to the part-decoded string or a part-decoded file through the Parts properties, fills out automatically the part headers into the Parts properties 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

__property String Boundary = { read=FBoundary, write=FSetBoundary };

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.

Data Type

String

ContentType Property (MIME Component)

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

Syntax

__property String ContentType = { read=FContentType, write=FSetContentType };

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.

Data Type

String

ContentTypeAttr Property (MIME Component)

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

Syntax

__property String ContentTypeAttr = { read=FContentTypeAttr, write=FSetContentTypeAttr };

Default Value

""

Remarks

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

Data Type

String

Message Property (MIME Component)

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

Syntax

__property String Message = { read=FMessage, write=FSetMessage };
__property DynamicArray<Byte> MessageB = { read=FMessageB, write=FSetMessageB };

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.

Data Type

Byte Array

MessageHeaderCount Property (MIME Component)

The number of records in the MessageHeader arrays.

Syntax

__property int MessageHeaderCount = { read=FMessageHeaderCount, write=FSetMessageHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageHeaderField
• MessageHeaderValue

The array indices start at 0 and end at MessageHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MessageHeaderField Property (MIME Component)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

__property String MessageHeaderField[int MessageHeaderIndex] = { read=FMessageHeaderField, write=FSetMessageHeaderField };

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeaderValue Property (MIME Component)

This property contains the header contents.

Syntax

__property String MessageHeaderValue[int MessageHeaderIndex] = { read=FMessageHeaderValue, write=FSetMessageHeaderValue };

Default Value

""

Remarks

This property contains the Header contents.

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeadersString Property (MIME Component)

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

Syntax

__property String MessageHeadersString = { read=FMessageHeadersString, write=FSetMessageHeadersString };

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.

Data Type

String

PartCount Property (MIME Component)

The number of records in the Part arrays.

Syntax

__property int PartCount = { read=FPartCount, write=FSetPartCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PartContentDisposition
• PartContentDispositionAttr
• PartContentId
• PartContentType
• PartContentTypeAttr
• PartDecodedFile
• PartDecodedString
• PartEncoding
• PartFileName
• PartHeaders
• PartName
• PartSize

The array indices start at 0 and end at PartCount - 1.

This property is not available at design time.

Data Type

Integer

PartContentDisposition Property (MIME Component)

This property contains content disposition for each part.

Syntax

__property String PartContentDisposition[int PartIdx] = { read=FPartContentDisposition, write=FSetPartContentDisposition };

Default Value

""

Remarks

This property contains content disposition for each part.

The value in this property is used in the Content-Disposition header. Typical values include "form-data" and "attachment". The component fills it out each time the PartDecodedFile is changed. Changing the PartContentDisposition recalculates the PartHeaders as well.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

String

PartContentDispositionAttr Property (MIME Component)

This property contains the content disposition's attribute (if any) for each part.

Syntax

__property String PartContentDispositionAttr[int PartIdx] = { read=FPartContentDispositionAttr, write=FSetPartContentDispositionAttr };

Default Value

""

Remarks

This property contains the content disposition's attribute (if any) for each part.

Typical values for this property are the names of the form-variables used while creating an HTTP post or the values for filenames.

Setting this property recalculates the PartHeaders.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

String

PartContentId Property (MIME Component)

This property contains the content identifier for each part.

Syntax

__property String PartContentId[int PartIdx] = { read=FPartContentId, write=FSetPartContentId };

Default Value

""

Remarks

This property contains the content identifier for each part. The value of this property is used in the Content-Id header. The component fills it out each time the PartDecodedFile is changed. Changing this property recalculates the PartHeaders as well.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

String

PartContentType Property (MIME Component)

This property contains the content type for each part.

Syntax

__property String PartContentType[int PartIdx] = { read=FPartContentType, write=FSetPartContentType };

Default Value

""

Remarks

This property contains the content type for each part. The value of this property is used in the Content-Type header. Typical values include "image/gif" and "text/plain". The component fills it out each time the PartDecodedFile is changed. Changing this property recalculates the PartHeaders as well.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

String

PartContentTypeAttr Property (MIME Component)

This property contains the content-type attribute, if any, for each part.

Syntax

__property String PartContentTypeAttr[int PartIdx] = { read=FPartContentTypeAttr, write=FSetPartContentTypeAttr };

Default Value

""

Remarks

This property contains the content-type attribute, if any, for each part. Setting this recalculates the PartHeaders as well.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

String

PartDecodedFile Property (MIME Component)

This property may be set to a file on disk before calling EncodeToString , EncodeToFile or EncodeToStream .

Syntax

__property String PartDecodedFile[int PartIdx] = { write=FSetPartDecodedFile };

Default Value

""

Remarks

This property may be set to a file on disk before calling EncodeToString, EncodeToFile or EncodeToStream. When encoding, data for the part will be read from the specified file.

When decoding, call DecodePartToFile to decode a specific part to a file on disk.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is write-only and not available at design time.

Data Type

String

PartDecodedString Property (MIME Component)

This property holds the actual content of each part.

Syntax

__property String PartDecodedString[int PartIdx] = { read=FPartDecodedString, write=FSetPartDecodedString };
__property DynamicArray<Byte> PartDecodedStringB[int PartIdx] = { read=FPartDecodedStringB, write=FSetPartDecodedStringB };

Default Value

""

Remarks

This property holds the actual content of each part. The component decodes the actual part of Message to PartDecodedString when PartDecodedString's value is first queried.

Setting a value to PartDecodedString fills out the corresponding PartSize with the string size if the corresponding PartDecodedFile is empty.

The component checks during encoding first PartDecodedFile: if it is empty, then the component uses the value of PartDecodedString.

Note: It is recommended to use the DecodePart method instead of querying this property.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

Byte Array

PartEncoding Property (MIME Component)

This property contains the actual content encoding type for each part.

Syntax

__property TipwMIMEPartEncodings PartEncoding[int PartIdx] = { read=FPartEncoding, write=FSetPartEncoding };

enum TipwMIMEPartEncodings {
  pe7Bit=0,
  peQuotedPrintable=1,
  peBase64=2,
  pe8Bit=3,
  peBinary=4,
  peUUEncode=5
};

Default Value

pe7Bit

Remarks

This property contains the actual content encoding type for each part. This property determines how to encode the data or how they actually were encoded in the Message, as specified in the Content-Transfer-Encoding header.

Possible values for the this property are as follows:

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

Integer

PartFileName Property (MIME Component)

This property contains the filename attribute specified in the headers of the part.

Syntax

__property String PartFileName[int PartIdx] = { read=FPartFileName, write=FSetPartFileName };

Default Value

""

Remarks

This property contains the filename attribute specified in the headers of the part. Changing the value of the corresponding PartDecodedFile automatically sets the PartFileName and consequently the PartHeaders.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

String

PartHeaders Property (MIME Component)

This property contains the headers for each MIME part.

Syntax

__property String PartHeaders[int PartIdx] = { read=FPartHeaders, write=FSetPartHeaders };

Default Value

""

Remarks

This property contains the headers for each MIME part. The component fills out this property each time any of the other corresponding part properties are changed. If additional headers are needed, they should be appended after all of the other corresponding part properties are set.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

String

PartName Property (MIME Component)

This property contains the name given to a part, such as the filename.

Syntax

__property String PartName[int PartIdx] = { read=FPartName, write=FSetPartName };

Default Value

""

Remarks

This property contains the name given to a part, such as the filename. Changing the value of PartDecodedFile automatically sets the corresponding PartName and consequently the PartHeaders.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is not available at design time.

Data Type

String

PartSize Property (MIME Component)

This property contains the size of the DecodedFile or DecodedString .

Syntax

__property int PartSize[int PartIdx] = { read=FPartSize };

Default Value

0

Remarks

This property contains the size of the PartDecodedFile or PartDecodedString. If a non-empty value is assigned to PartDecodedFile, then component fills out the corresponding PartSize with the file size; if the file does not exist, an error occurs.

If the PartDecodedFile is empty and a value is assigned to PartDecodedString, then the corresponding PartSize will be equal to the string's size.

During decoding, this property is filled with the size of that part.

The PartIdx parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

Integer

Config Method (MIME Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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

void __fastcall DecodeFromFile();

Remarks

This method decodes the data file given in Message and optionally MessageHeaders and fills out the Parts properties 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.

DecodeFromString Method (MIME Component)

This method decodes from a string.

Syntax

void __fastcall DecodeFromString();

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 properties.

Example. Decoding a Mail Message:

MIMEControl.MessageHeadersString = MailControl.MessageHeaders MIMEControl.Message = MailControl.MessageText MIMEControl.DecodeFromString

DecodePart Method (MIME Component)

This method decodes the specified part.

Syntax

DynamicArray<Byte> __fastcall DecodePart(int index);

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 PartDecodedString property 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

String __fastcall DecodePartToFile(int index);

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.

EncodeToFile Method (MIME Component)

This method encodes to a file.

Syntax

void __fastcall EncodeToFile();

Remarks

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

The component will check for each item in Parts properties (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.PartCount = 2 MIMEControl.PartDecodedString(0) = "This is plain text data" MIMEControl.PartEncoding(0) = peQuotedPrintable MIMEControl.PartContentType(0) = "text/plain" MIMEControl.PartDecodedFile(1) = "C:\filename.txt" MIMEControl.Message = "temp.tmp" MIMEControl.EncodeToFile()

EncodeToString Method (MIME Component)

This method encodes to a string.

Syntax

void __fastcall EncodeToString();

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 properties into a MIME message. The message gets stored in Message and MessageHeaders using the values optionally given in Parts properties. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts properties by calling ResetData.

The component will check each item in the Parts properties (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.PartCount = 2 MIMEControl.PartDecodedString(0) = "This is plain text data" MIMEControl.PartEncoding(0) = peQuotedPrintable MIMEControl.PartContentType(0) = "text/plain" MIMEControl.PartDecodedFile(1) = "C:\filename.txt" MIMEControl.EncodeToString()

Reset Method (MIME Component)

This method will reset the component.

Syntax

void __fastcall Reset();

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

void __fastcall ResetData();

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)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipwMIMEErrorEventParams;
typedef void __fastcall (__closure *TipwMIMEErrorEvent)(System::TObject* Sender, TipwMIMEErrorEventParams *e);
__property TipwMIMEErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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

typedef struct {
  int PartIndex;
  String Field;
  String Value;
  DynamicArray<Byte> ValueB;
} TipwMIMEHeaderEventParams;
typedef void __fastcall (__closure *TipwMIMEHeaderEvent)(System::TObject* Sender, TipwMIMEHeaderEventParams *e);
__property TipwMIMEHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };

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

typedef struct {
  int PercentDone;
} TipwMIMEProgressEventParams;
typedef void __fastcall (__closure *TipwMIMEProgressEvent)(System::TObject* Sender, TipwMIMEProgressEventParams *e);
__property TipwMIMEProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

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.

Config Settings (MIME Component)

The component accepts one or more of the following configuration settings. Configuration 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.

MIME Config Settings

Base Config Settings

Trappable Errors (MIME Component)

MIME Errors