# MIME Class

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

## Syntax

```text
MIME
```

## Remarks

The class may be used for decoding or encoding of messages. [Message](#message-property-mime-class) holds the content of the encoded message or the filename that holds the encoded data. The decoded data are provided in [Parts](#parts-property-mime-class) collection.

To decode a MIME message, you should first assign either the whole message (headers and body) to [Message](#message-property-mime-class) or put the message headers into the [MessageHeaders](#messageheaders-property-mime-class) property and the message body or the filename holding it into the [Message](#message-property-mime-class) property. Calling [DecodeFromFile](#decodefromfile-method-mime-class) or [DecodeFromString](#decodefromstring-method-mime-class) directs the class to start parsing the message: it will fill out the [ContentType](#contenttype-property-mime-class) and [ContentTypeAttr](#contenttypeattr-property-mime-class) properties with message content-type information, and it will enter information about message parts into the [Parts](#parts-property-mime-class) 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](#decodefromstring-method-mime-class) or [DecodeFromFile](#decodefromfile-method-mime-class) to decode does not actually decode the message but only parses it. The real decoding is done when the part content in the [Parts](#parts-property-mime-class) 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](#parts-property-mime-class) collection property, and optionally assign values to the other part attributes in the [Parts](#parts-property-mime-class) collection. Assigning a value to the part-decoded string or a part-decoded file through the [Parts](#parts-property-mime-class) collection, fills out automatically the part headers into the [Parts](#parts-property-mime-class) collection for the respective part. Calling [EncodeToFile](#encodetofile-method-mime-class) or [EncodeToString](#encodetostring-method-mime-class) directs the class to fill out the [Message](#message-property-mime-class) with the message body and the [MessageHeaders](#messageheaders-property-mime-class) with the headers.

The [Progress](#progress-event-mime-class) 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 class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Boundary](#boundary-property-mime-class) | This property includes the boundary separating the MIME parts. It has a maximum length of 80 bytes. |
| [ContentType](#contenttype-property-mime-class) | This property includes the value of the content-type header of the message that was encoded/decoded. |
| [ContentTypeAttr](#contenttypeattr-property-mime-class) | This property includes the attributes of the content-type header of the message that was encoded or decoded. |
| [Message](#message-property-mime-class) | This property contains the encoded message text or a path to a file that contains the encoded message text. |
| [MessageHeaders](#messageheaders-property-mime-class) | This property includes the headers of the MIME message. |
| [MessageHeadersString](#messageheadersstring-property-mime-class) | This property includes the string version of the MIME message headers. |
| [Parts](#parts-property-mime-class) | This property contains information about all parts of a MIME message. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-mime-class) | Sets or retrieves a configuration setting. |
| [DecodeFromFile](#decodefromfile-method-mime-class) | This method decodes from a file. |
| [DecodeFromStream](#decodefromstream-method-mime-class) | This method decodes from a stream. |
| [DecodeFromString](#decodefromstring-method-mime-class) | This method decodes from a string. |
| [DecodePart](#decodepart-method-mime-class) | This method decodes the specified part. |
| [DecodePartToFile](#decodeparttofile-method-mime-class) | This method decodes the specified part to a file on disk. |
| [EncodeToFile](#encodetofile-method-mime-class) | This method encodes to a file. |
| [EncodeToStream](#encodetostream-method-mime-class) | This method encodes to a stream. |
| [EncodeToString](#encodetostring-method-mime-class) | This method encodes to a string. |
| [Reset](#reset-method-mime-class) | This method will reset the class. |
| [ResetData](#resetdata-method-mime-class) | This method resets the values of all headers and part properties. |

## Event List

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

|  |  |
| --- | --- |
| [Error](#error-event-mime-class) | Fired when information is available about errors during data delivery. |
| [Header](#header-event-mime-class) | This event is fired every time a header is parsed. |
| [Progress](#progress-event-mime-class) | This event shows the progress of decoding or encoding the input data. |

## Config Settings

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

|  |  |
| --- | --- |
| [DecodeMessageHeaders](#DecodeMessageHeaders) | Instructs the class to automatically decode message headers. |
| [IncludeHeaders](#IncludeHeaders) | Tells the class whether to include the headers when encoding the message. |
| [RequireVersionHeader](#RequireVersionHeader) | Specifies whether or not the class should require the version header. |
| [SanitizeFileName](#SanitizeFileName) | Whether invalid characters are replaced in MIME part filenames. |
| [TempFilePath](#TempFilePath) | If set, the temporary files created during MIME decoding and encoding will be put in the path specified. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Boundary Property ([MIME](#mime-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetBoundary();int SetBoundary(const char* lpszBoundary);

Unicode (Windows)
LPWSTR GetBoundary();INT SetBoundary(LPCWSTR lpszBoundary);
```

## Default Value

""

## Remarks

This property contains the boundary separating the MIME parts and has a maximum length of 80 bytes. The class 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 class will truncate any string longer than 80 bytes if assigned to Boundary.

## Data Type

String

# ContentType Property ([MIME](#mime-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetContentType();int SetContentType(const char* lpszContentType);

Unicode (Windows)
LPWSTR GetContentType();INT SetContentType(LPCWSTR lpszContentType);
```

## Default Value

""

## Remarks

This property contains the value of the content-type header of the message that was encoded/decoded. The class filters it out from the [MessageHeaders](#messageheaders-property-mime-class). 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](#mime-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetContentTypeAttr();int SetContentTypeAttr(const char* lpszContentTypeAttr);

Unicode (Windows)
LPWSTR GetContentTypeAttr();INT SetContentTypeAttr(LPCWSTR lpszContentTypeAttr);
```

## Default Value

""

## Remarks

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

## Data Type

String

# Message Property ([MIME](#mime-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetMessage(char* &lpMessage, int &lenMessage);int SetMessage(const char* lpMessage, int lenMessage);

Unicode (Windows)
INT GetMessage(LPSTR &lpMessage, INT &lenMessage);INT SetMessage(LPCSTR lpMessage, INT lenMessage);
```

## Default Value

""

## Remarks

This property contains the encoded message text or a path to a file that contains the encoded message text. The class fills out this property with the message body and [MessageHeaders](#messageheaders-property-mime-class) during encoding. The user may assign both the headers and the body to this property and leave [MessageHeaders](#messageheaders-property-mime-class) empty before decoding.

This property is not available at design time.

## Data Type

Binary String

# MessageHeaders Property ([MIME](#mime-class) Class)

This property includes the headers of the MIME message.

## Syntax

```text
IPWorksSMIMEList<IPWorksSMIMEHeader>* GetMessageHeaders();
int SetMessageHeaders(IPWorksSMIMEList<IPWorksSMIMEHeader>* val);
```

## Remarks

This property contains the headers of the MIME message. The class fills out this property upon encoding. The user should use them as additional headers when emailing the [Message](#message-property-mime-class).

During decoding, if this property is empty, the class will try to find the headers in the beginning of the [Message](#message-property-mime-class) and then will fill out this property accordingly.

## Data Type

[IPWorksSMIMEHeader](#header-type)

# MessageHeadersString Property ([MIME](#mime-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageHeadersString();int SetMessageHeadersString(const char* lpszMessageHeadersString);

Unicode (Windows)
LPWSTR GetMessageHeadersString();INT SetMessageHeadersString(LPCWSTR lpszMessageHeadersString);
```

## Default Value

""

## Remarks

The component fills out MessageHeadersString upon encoding. The user should use these strings as additional headers when emailing the [Message](#message-property-mime-class).

This property contains a string version of the MIME message headers. During decoding, if this property is empty, the class will try to find the headers in the beginning of the [Message](#message-property-mime-class) and will fill out this property accordingly.

## Data Type

String

# Parts Property ([MIME](#mime-class) Class)

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

## Syntax

```text
IPWorksSMIMEList<IPWorksSMIMEMIMEPart>* GetParts();
int SetParts(IPWorksSMIMEList<IPWorksSMIMEMIMEPart>* val);
```

## 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](#MIMEPart_f_Headers) field.

The MIMEPARTS collection is filled out by the class when a call to either [DecodeFromFile](#decodefromfile-method-mime-class) or [DecodeFromString](#decodefromstring-method-mime-class) is made. However, when the [EncodeToFile](#encodetofile-method-mime-class) or [EncodeToString](#encodetostring-method-mime-class) methods are called, the class encodes the data given in either [DecodedFile](#MIMEPart_f_DecodedFile) or [DecodedString](#MIMEPart_f_DecodedString) into a MIME message.

## Data Type

[IPWorksSMIMEMIMEPart](#mimepart-type)

# Config Method ([MIME](#mime-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-mime-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#config-settings-mime-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# DecodeFromFile Method ([MIME](#mime-class) Class)

This method decodes from a file.

## Syntax

```text
ANSI (Cross Platform)
int DecodeFromFile();

Unicode (Windows)
INT DecodeFromFile();
```

## Remarks

This method decodes the data file given in [Message](#message-property-mime-class) and optionally [MessageHeaders](#messageheaders-property-mime-class) and fills out the [Parts](#parts-property-mime-class) collection for each decoded part.

**Example. Decoding from a File:**

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

In this example, *C:\filename.txt* must contain the MIME headers and body. If not, the [MessageHeaders](#messageheaders-property-mime-class) property must be set to the appropriate MIME headers.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DecodeFromStream Method ([MIME](#mime-class) Class)

This method decodes from a stream.

## Syntax

```text
ANSI (Cross Platform)
int DecodeFromStream(IPWorksSMIMEStream* sInputStream);

Unicode (Windows)
INT DecodeFromStream(IPWorksSMIMEStream* sInputStream);
```

## 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](#messageheaders-property-mime-class) and fills out the [Parts](#parts-property-mime-class) collection.

**Example. Decoding a Mail Message:**

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DecodeFromString Method ([MIME](#mime-class) Class)

This method decodes from a string.

## Syntax

```text
ANSI (Cross Platform)
int DecodeFromString();

Unicode (Windows)
INT DecodeFromString();
```

## Remarks

This method decodes from a string. It is the same as DecodeFromFile, but now the [Message](#message-property-mime-class) denotes the real encoded message rather than a filename.

This method decodes the data given in [Message](#message-property-mime-class) and optionally [MessageHeaders](#messageheaders-property-mime-class) and fills out the [Parts](#parts-property-mime-class) collection.

**Example. Decoding a Mail Message:**

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DecodePart Method ([MIME](#mime-class) Class)

This method decodes the specified part.

## Syntax

```text
ANSI (Cross Platform)
char* DecodePart(int iindex, int *lpSize = NULL);

Unicode (Windows)
LPSTR DecodePart(INT iindex, LPINT lpSize = NULL);
```

## Remarks

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

[DecodeFromString](#decodefromstring-method-mime-class) or [DecodeFromFile](#decodefromfile-method-mime-class) must be called before calling this method. Calling this method will return the decoded bytes, and in addition, the [DecodedString](#MIMEPart_f_DecodedString) field will be populated with the string representation of the decoded data.

**Example. Decoding a Specified Part:**

```csharp
mime.MessageHeadersString = myMessageHeaders;
mime.Message = myMessageBody;
mime.DecodeFromString();

byte[] myPartContent = await mime.DecodePart(0);
```

## Error Handling (C++)

This method returns a Binary String value (with length *lpSize*); after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# DecodePartToFile Method ([MIME](#mime-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* DecodePartToFile(int iindex);

Unicode (Windows)
LPWSTR DecodePartToFile(INT iindex);
```

## 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](#decodefromstring-method-mime-class) or [DecodeFromFile](#decodefromfile-method-mime-class) must be called before calling this method.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# EncodeToFile Method ([MIME](#mime-class) Class)

This method encodes to a file.

## Syntax

```text
ANSI (Cross Platform)
int EncodeToFile();

Unicode (Windows)
INT EncodeToFile();
```

## Remarks

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

The class will check for each item in [Parts](#parts-property-mime-class) 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](#message-property-mime-class); the message headers will be held by [MessageHeaders](#messageheaders-property-mime-class).

**Example. Encoding Data:**

```text
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()
```

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# EncodeToStream Method ([MIME](#mime-class) Class)

This method encodes to a stream.

## Syntax

```text
ANSI (Cross Platform)
int EncodeToStream(IPWorksSMIMEStream* sOutputStream);

Unicode (Windows)
INT EncodeToStream(IPWorksSMIMEStream* sOutputStream);
```

## Remarks

This method encodes to a stream. It is the same as [EncodeToString](#encodetostring-method-mime-class), but the encoded data are written to a stream instead of to the [Message](#message-property-mime-class) property.

This method encodes the data given in [Parts](#parts-property-mime-class) collection into a MIME message. The Message gets written to the specified *OutputStream* and [MessageHeaders](#messageheaders-property-mime-class) using the values optionally given in the [Parts](#parts-property-mime-class) collection. To encode several objects into a MIME envelope, the user should first clear any old values left in the [Parts](#parts-property-mime-class) collection by calling [ResetData](#resetdata-method-mime-class).

The class will check each item in the [Parts](#parts-property-mime-class) 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](#messageheaders-property-mime-class).

**Example. Encoding Data:**

```text
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)
```

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# EncodeToString Method ([MIME](#mime-class) Class)

This method encodes to a string.

## Syntax

```text
ANSI (Cross Platform)
int EncodeToString();

Unicode (Windows)
INT EncodeToString();
```

## Remarks

This method encodes to a string. It is the same as [EncodeToFile](#encodetofile-method-mime-class) but the encoded data are held in the [Message](#message-property-mime-class) property rather than saved to a file.

This method encodes the data given in the [Parts](#parts-property-mime-class) collection into a MIME message. The message gets stored in [Message](#message-property-mime-class) and [MessageHeaders](#messageheaders-property-mime-class) using the values optionally given in [Parts](#parts-property-mime-class) collection. To encode several objects into a MIME envelope, the user should first clear any old values left in the [Parts](#parts-property-mime-class) collection by calling [ResetData](#resetdata-method-mime-class).

The class will check each item in the [Parts](#parts-property-mime-class) collection (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be stored in the [Message](#message-property-mime-class) property; the message headers will be held by [MessageHeaders](#messageheaders-property-mime-class).

**Example. Encoding Data:**

```text
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()
```

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Reset Method ([MIME](#mime-class) Class)

This method will reset the class.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ResetData Method ([MIME](#mime-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int ResetData();

Unicode (Windows)
INT ResetData();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Error Event ([MIME](#mime-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(MIMEErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} MIMEErrorEventParams;

Unicode (Windows)
virtual INT FireError(MIMEErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} MIMEErrorEventParams;
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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](#trappable-errors-mime-class) section.

# Header Event ([MIME](#mime-class) Class)

This event is fired every time a header is parsed.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireHeader(MIMEHeaderEventParams *e);
typedef struct {  int PartIndex;  const char *Field;  const char *Value;
  int lenValue;
  int reserved;
} MIMEHeaderEventParams;

Unicode (Windows)
virtual INT FireHeader(MIMEHeaderEventParams *e);
typedef struct {  INT PartIndex;  LPCWSTR Field;  LPCSTR Value;
  INT lenValue;
  INT reserved;
} MIMEHeaderEventParams;
```

## 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](#decodefromfile-method-mime-class), [DecodeFromString](#decodefromstring-method-mime-class), or [DecodeFromStream](#decodefromstream-method-mime-class) is called.

# Progress Event ([MIME](#mime-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireProgress(MIMEProgressEventParams *e);
typedef struct {  int PercentDone;
  int reserved;
} MIMEProgressEventParams;

Unicode (Windows)
virtual INT FireProgress(MIMEProgressEventParams *e);
typedef struct {  INT PercentDone;
  INT reserved;
} MIMEProgressEventParams;
```

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

## Syntax

 *IPWorksSMIMEHeader* (declared in *ipworkssmime.h*)

## Remarks

When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value).

The following fields are available:

- [Field](#Header_f_Field)

- [Value](#Header_f_Value)

## Fields

 **Field** *char**
*Default Value: ""*

This field contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered).

 **Value** *char**
*Default Value: ""*

This field contains the [Header](#header-type) contents.

## Constructors

```text
Header()
```

```text
Header(const char* lpszField, const char* lpszValue)
```

# MIMEPart Type

This is a part of the MIME message.

## Syntax

 *IPWorksSMIMEMIMEPart* (declared in *ipworkssmime.h*)

## 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](#messageheaders-property-mime-class) and the [Message](#message-property-mime-class) body. The body is then split into MIME parts by a specified or generated [Boundary](#boundary-property-mime-class). Each part of a MIME message has its own [Headers](#MIMEPart_f_Headers) as well. These headers describe the [MIMEPart](#mimepart-type) and its contents.

The decoded data will be held in [DecodedString](#MIMEPart_f_DecodedString) or otherwise will be saved in a temporary file given by [DecodedFile](#MIMEPart_f_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](#MIMEPart_f_DecodedFile) field. Otherwise, the decoded data will be in the [DecodedString](#MIMEPart_f_DecodedString) field.

When the [EncodeToString](#encodetostring-method-mime-class) method is called, the class will check for each item in the [Parts](#parts-property-mime-class) (first the [DecodedFile](#MIMEPart_f_DecodedFile) and then the [DecodedString](#MIMEPart_f_DecodedString)) for the data to encode.

The following fields are available:

- [ContentDisposition](#MIMEPart_f_ContentDisposition)

- [ContentDispositionAttr](#MIMEPart_f_ContentDispositionAttr)

- [ContentId](#MIMEPart_f_ContentId)

- [ContentType](#MIMEPart_f_ContentType)

- [ContentTypeAttr](#MIMEPart_f_ContentTypeAttr)

- [DecodedFile](#MIMEPart_f_DecodedFile)

- [DecodedString](#MIMEPart_f_DecodedString)

- [Encoding](#MIMEPart_f_Encoding)

- [FileName](#MIMEPart_f_FileName)

- [Headers](#MIMEPart_f_Headers)

- [Name](#MIMEPart_f_Name)

- [Size](#MIMEPart_f_Size)

## Fields

 **ContentDisposition** *char**
*Default Value: ""*

This field contains content disposition for each part.

The value in this field is used in the *Content-Disposition* header. Typical values include "form-data" and "attachment". The class fills it out each time the [DecodedFile](#MIMEPart_f_DecodedFile) is changed. Changing the [ContentDisposition](#MIMEPart_f_ContentDisposition) recalculates the [Headers](#MIMEPart_f_Headers) as well.

 **ContentDispositionAttr** *char**
*Default Value: ""*

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

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

Setting this field recalculates the [Headers](#MIMEPart_f_Headers).

 **ContentId** *char**
*Default Value: ""*

This field contains the content identifier for each part. The value of this field is used in the *Content-Id* header. The class fills it out each time the [DecodedFile](#MIMEPart_f_DecodedFile) is changed. Changing this field recalculates the [Headers](#MIMEPart_f_Headers) as well.

 **ContentType** *char**
*Default Value: ""*

This field contains the content type for each part. The value of this field is used in the *Content-Type* header. Typical values include "image/gif" and "text/plain". The class fills it out each time the [DecodedFile](#MIMEPart_f_DecodedFile) is changed. Changing this field recalculates the [Headers](#MIMEPart_f_Headers) as well.

 **ContentTypeAttr** *char**
*Default Value: ""*

This field contains the content-type attribute, if any, for each part. Setting this recalculates the [Headers](#MIMEPart_f_Headers) as well.

 **DecodedFile** *char**
*Default Value: ""*

This field may be set to a file on disk before calling [EncodeToString](#encodetostring-method-mime-class), [EncodeToFile](#encodetofile-method-mime-class) or [EncodeToStream](#encodetostream-method-mime-class). When encoding, data for the part will be read from the specified file.

When decoding, call [DecodePartToFile](#decodeparttofile-method-mime-class) to decode a specific part to a file on disk.

 **DecodedString** *char**
*Default Value: ""*

This field holds the actual content of each part. The class decodes the actual part of [Message](#message-property-mime-class) to [DecodedString](#MIMEPart_f_DecodedString) when [DecodedString](#MIMEPart_f_DecodedString)'s value is first queried.

Setting a value to [DecodedString](#MIMEPart_f_DecodedString) fills out the corresponding [Size](#MIMEPart_f_Size) with the string size if the corresponding [DecodedFile](#MIMEPart_f_DecodedFile) is empty.

The class checks during encoding first [DecodedFile](#MIMEPart_f_DecodedFile): if it is empty, then the class uses the value of [DecodedString](#MIMEPart_f_DecodedString).

NOTE: It is recommended to use the [DecodePart](#decodepart-method-mime-class) method instead of querying this property.

 **Encoding** *int*
*Default Value: 0*

This field contains the actual content encoding type for each part. This field determines how to encode the data or how they actually were encoded in the [Message](#message-property-mime-class), as specified in the *Content-Transfer-Encoding* header.

Possible values for the this field are as follows:

|  |  |
| --- | --- |
| pe7bit (0) | 7 Bit data, no encoding. |
| peQuotedPrintable (1) | Quoted-Printable encoding of (typically) text. |
| peBase64 (2) | Base64 encoding of binary data. |
| pe8Bit (3) | No encoding, 8-bit characters may be contained as well. |
| peBinary (4) | Binary data without any encoding. Similar to 3 (8-bit encoding). |
| peUUEncode (5) | Uuencoding of binary data. |

 **FileName** *char**
*Default Value: ""*

This field contains the filename attribute specified in the headers of the part. Changing the value of the corresponding [DecodedFile](#MIMEPart_f_DecodedFile) automatically sets the [FileName](#MIMEPart_f_FileName) and consequently the [Headers](#MIMEPart_f_Headers).

 **Headers** *char**
*Default Value: ""*

This field contains the headers for each MIME part. The class fills out this field 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.

 **Name** *char**
*Default Value: ""*

This field contains the name given to a part, such as the filename. Changing the value of [DecodedFile](#MIMEPart_f_DecodedFile) automatically sets the corresponding [Name](#MIMEPart_f_Name) and consequently the [Headers](#MIMEPart_f_Headers).

 **Size** *int (read-only)*
*Default Value: 0*

This field contains the size of the [DecodedFile](#MIMEPart_f_DecodedFile) or [DecodedString](#MIMEPart_f_DecodedString). If a non-empty value is assigned to [DecodedFile](#MIMEPart_f_DecodedFile), then class fills out the corresponding [Size](#MIMEPart_f_Size) with the file size; if the file does not exist, an error occurs.

If the [DecodedFile](#MIMEPart_f_DecodedFile) is empty and a value is assigned to [DecodedString](#MIMEPart_f_DecodedString), then the corresponding [Size](#MIMEPart_f_Size) will be equal to the string's size.

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

## Constructors

```text
MIMEPart()
```

```text
MIMEPart(const char* lpszDecodedFile)
```

```text
MIMEPart(const char* lpDecodedString, int lenDecodedString)
```

```text
MIMEPart(IPWorksSMIMEStream* sPartInputStream)
```

# IPWorksSMIMEList Type

## Syntax

 *IPWorksSMIMEList<T>* (declared in *ipworkssmime.h*)

## Remarks

 *IPWorksSMIMEList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the MIME class.

```text
int GetCount() {}
```

```text
int SetCount(int count) {}
```

```text
T* Get(int index) {}
```

```text
T* Set(int index, T* value) {}
```

|  |  |
| --- | --- |
| Methods |  |
| GetCount | This method returns the current size of the collection. |
| SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. |
| Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. |
| Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. |

# IPWorksSMIMEStream Type

## Syntax

 *IPWorksSMIMEStream* (declared in *ipworkssmime.h*)

## Remarks

 The MIME class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksSMIMEStream interface and pass the MIME class an instance of that concrete class.

 When implementing the IPWorksSMIMEStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

```text
bool CanRead() { return true; }
```

```text
bool CanSeek() { return true; }
```

```text
bool CanWrite() { return true; }
```

```text
int64 GetLength() = 0;
```

```text
void Close() {}
```

```text
int Flush() { return 0; }
```

```text
int Read(void* buffer, int count) = 0;
```

```text
int64 Seek(int64 offset, int seekOrigin) = 0;
```

```text
int Write(const void* buffer, int count) = 0;
```

|  |  |
| --- | --- |
| Properties |  |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods |  |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when an IPWorksSMIMEStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |

# Config Settings ([MIME](#mime-class) Class)

 The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-mime-class) method.

### MIME Config Settings

**DecodeMessageHeaders**: Instructs the component to automatically decode message headers.Message headers that have been Quoted-Printable or Base64 encoded are automatically decoded when this configuration setting is True. The default value of this setting is False.

**IncludeHeaders**: Tells the class whether to include the headers when encoding the message.If True, the class will include the headers when [EncodeToFile](#encodetofile-method-mime-class) or [EncodeToString](#encodetostring-method-mime-class) are called. If False, only the message will be encoded.

The default value for [IncludeHeaders](#IncludeHeaders) is False.

**RequireVersionHeader**: Specifies whether or not the class should require the version header.If True, the class will require that the "MIME-Version" header be included in the [MessageHeaders](#messageheaders-property-mime-class). If the header is not present during decoding, the component fails with an error. This configuration setting is False by default.

**SanitizeFileName**: Whether invalid characters are replaced in MIME part filenames.If True, the class will replace invalid characters with an underscore when decoding the MIME message. This applies to the filename held in the [FileName](#MIMEPart_f_FileName) field. When True, the following characters are considered invalid:

- \
- /
- "
- :
- ?
- *
- <
- >
- |

 Any characters with ASCII values between 0 and 31 are also considered invalid. The default value is False.

**TempFilePath**: If set, the temporary files created during MIME decoding and encoding will be put in the path specified. The [TempFilePath](#TempFilePath) property sets the path at which the temporary files will be created.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([MIME](#mime-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

### MIME Errors

|  |  |
| --- | --- |
| 3 | Can't create the file for write (illegal name or disk is write-protected). |
| 4 | Can't open the file for read (doesn't exist?). |
| 5 | Can't read from file. |
| 6 | Can't write to file (disk full?). |
| 280 | Invalid Part Index. |
| 281 | Unknown MIME type. |
| 282 | No MIME-boundary found. |
| 283 | No file given. |
| 284 | The class is busy. |
| 285 | Can't create a temporary file to decode the data. |
| 286 | Can't read [Message](#message-property-mime-class) file. |
| 287 | No header separator found. |
| 289 | No separator found. |
| 290 | Input stream must have seeking enabled. |