# Struct ipworkspgp::MIME

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

## Syntax

```text
ipworkspgp::MIME
```

## Remarks

The struct may be used for decoding or encoding of messages. [message](#message-property-mime-struct) 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](#message-property-mime-struct) or put the message headers into the message_headers property and the message body or the filename holding it into the [message](#message-property-mime-struct) property. Calling [decode_from_file](#decode_from_file-method-mime-struct) or [decode_from_string](#decode_from_string-method-mime-struct) directs the struct to start parsing the message: it will fill out the [content_type](#content_type-property-mime-struct) and [content_type_attr](#content_type_attr-property-mime-struct) 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 [decode_from_string](#decode_from_string-method-mime-struct) or [decode_from_file](#decode_from_file-method-mime-struct) 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 [encode_to_file](#encode_to_file-method-mime-struct) or [encode_to_string](#encode_to_string-method-mime-struct) directs the struct to fill out the [message](#message-property-mime-struct) with the message body and the message_headers with the headers.

The [on_progress](#on_progress-event-mime-struct) event is fired as the message is parsed and the data are decoded/encoded.

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksPGP. Due to this, the MIME struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of MIME when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [boundary](#boundary-property-mime-struct) | This property includes the boundary separating the MIME parts. It has a maximum length of 80 bytes. |
| [content_type](#content_type-property-mime-struct) | This property includes the value of the content-type header of the message that was encoded/decoded. |
| [content_type_attr](#content_type_attr-property-mime-struct) | This property includes the attributes of the content-type header of the message that was encoded or decoded. |
| [message](#message-property-mime-struct) | This property contains the encoded message text or a path to a file that contains the encoded message text. |
| [message_header_count](#message_header_count-property-mime-struct) | The number of records in the MessageHeader arrays. |
| [message_header_field](#message_header_field-property-mime-struct) | This property contains the name of the HTTP header (this is the same case as it is delivered). |
| [message_header_value](#message_header_value-property-mime-struct) | This property contains the header contents. |
| [message_headers_string](#message_headers_string-property-mime-struct) | This property includes the string version of the MIME message headers. |
| [part_count](#part_count-property-mime-struct) | The number of records in the Part arrays. |
| [part_content_disposition](#part_content_disposition-property-mime-struct) | This property contains content disposition for each part. |
| [part_content_disposition_attr](#part_content_disposition_attr-property-mime-struct) | This property contains the content disposition's attribute (if any) for each part. |
| [part_content_id](#part_content_id-property-mime-struct) | This property contains the content identifier for each part. |
| [part_content_type](#part_content_type-property-mime-struct) | This property contains the content type for each part. |
| [part_content_type_attr](#part_content_type_attr-property-mime-struct) | This property contains the content-type attribute, if any, for each part. |
| [part_decoded_file](#part_decoded_file-property-mime-struct) | This property may be set to a file on disk before calling EncodeToString , EncodeToFile or EncodeToStream . |
| [part_decoded_string](#part_decoded_string-property-mime-struct) | This property holds the actual content of each part. |
| [part_encoding](#part_encoding-property-mime-struct) | This property contains the actual content encoding type for each part. |
| [part_file_name](#part_file_name-property-mime-struct) | This property contains the filename attribute specified in the headers of the part. |
| [part_headers](#part_headers-property-mime-struct) | This property contains the headers for each MIME part. |
| [part_name](#part_name-property-mime-struct) | This property contains the name given to a part, such as the filename. |
| [part_size](#part_size-property-mime-struct) | This property contains the size of the DecodedFile or DecodedString . |

## Method List

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

|  |  |
| --- | --- |
| [config](#config-method-mime-struct) | Sets or retrieves a configuration setting. |
| [decode_from_file](#decode_from_file-method-mime-struct) | This method decodes from a file. |
| [decode_from_string](#decode_from_string-method-mime-struct) | This method decodes from a string. |
| [decode_part](#decode_part-method-mime-struct) | This method decodes the specified part. |
| [decode_part_to_file](#decode_part_to_file-method-mime-struct) | This method decodes the specified part to a file on disk. |
| [encode_to_file](#encode_to_file-method-mime-struct) | This method encodes to a file. |
| [encode_to_string](#encode_to_string-method-mime-struct) | This method encodes to a string. |
| [reset](#reset-method-mime-struct) | This method will reset the struct. |
| [reset_data](#reset_data-method-mime-struct) | 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 struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [on_error](#on_error-event-mime-struct) | Fired when information is available about errors during data delivery. |
| [on_header](#on_header-event-mime-struct) | This event is fired every time a header is parsed. |
| [on_progress](#on_progress-event-mime-struct) | This event shows the progress of decoding or encoding the input data. |

## Config Settings

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

|  |  |
| --- | --- |
| [DecodeMessageHeaders](#DecodeMessageHeaders) | Instructs the struct to automatically decode message headers. |
| [IncludeHeaders](#IncludeHeaders) | Tells the struct whether to include the headers when encoding the message. |
| [RequireVersionHeader](#RequireVersionHeader) | Specifies whether or not the struct 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. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# boundary property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn boundary(&self ) -> Result<String, IPWorksPGPError> fn set_boundary(&self, value : &str) ->  Option<IPWorksPGPError>
fn set_boundary_ref(&self, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# content_type property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn content_type(&self ) -> Result<String, IPWorksPGPError> fn set_content_type(&self, value : &str) ->  Option<IPWorksPGPError>
fn set_content_type_ref(&self, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

This property contains the value of the content-type header of the message that was encoded/decoded. The struct filters it out from the message_headers. 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

# content_type_attr property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn content_type_attr(&self ) -> Result<String, IPWorksPGPError> fn set_content_type_attr(&self, value : &str) ->  Option<IPWorksPGPError>
fn set_content_type_attr_ref(&self, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# message property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn message(&self ) -> Result<Vec<u8>, IPWorksPGPError> fn set_message(&self, value : Vec<u8>) ->  Option<IPWorksPGPError>
fn set_message_ref(&self, value : &[u8]) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

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

## Data Type

Vec

# message_header_count property ([MIME](#struct-ipworkspgpmime) Struct)

The number of records in the MessageHeader arrays.

## Syntax

*Rust Syntax*

```text
fn message_header_count(&self ) -> Result<i32, IPWorksPGPError> fn set_message_header_count(&self, value : i32) ->  Option<IPWorksPGPError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [message_header_field](#message_header_field-property-mime-struct)
- [message_header_value](#message_header_value-property-mime-struct)

The array indices start at *0* and end at *message_header_count - 1*.

## Data Type

i32

# message_header_field property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn message_header_field(&self , MessageHeaderIndex : i32) -> Result<String, IPWorksPGPError> fn set_message_header_field(&self, MessageHeaderIndex : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_message_header_field_ref(&self, MessageHeaderIndex : i32, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

This property contains the name of the HTTP [Header](#Type_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](#message_header_count-property-mime-struct) property.

## Data Type

String

# message_header_value property ([MIME](#struct-ipworkspgpmime) Struct)

This property contains the header contents.

## Syntax

*Rust Syntax*

```text
fn message_header_value(&self , MessageHeaderIndex : i32) -> Result<String, IPWorksPGPError> fn set_message_header_value(&self, MessageHeaderIndex : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_message_header_value_ref(&self, MessageHeaderIndex : i32, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

This property contains the [Header](#Type_Header) contents.

The *MessageHeaderIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageHeaderCount](#message_header_count-property-mime-struct) property.

## Data Type

String

# message_headers_string property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn message_headers_string(&self ) -> Result<String, IPWorksPGPError> fn set_message_headers_string(&self, value : &str) ->  Option<IPWorksPGPError>
fn set_message_headers_string_ref(&self, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

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

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

## Data Type

String

# part_count property ([MIME](#struct-ipworkspgpmime) Struct)

The number of records in the Part arrays.

## Syntax

*Rust Syntax*

```text
fn part_count(&self ) -> Result<i32, IPWorksPGPError> fn set_part_count(&self, value : i32) ->  Option<IPWorksPGPError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [part_content_disposition](#part_content_disposition-property-mime-struct)
- [part_content_disposition_attr](#part_content_disposition_attr-property-mime-struct)
- [part_content_id](#part_content_id-property-mime-struct)
- [part_content_type](#part_content_type-property-mime-struct)
- [part_content_type_attr](#part_content_type_attr-property-mime-struct)
- [part_decoded_file](#part_decoded_file-property-mime-struct)
- [part_decoded_string](#part_decoded_string-property-mime-struct)
- [part_encoding](#part_encoding-property-mime-struct)
- [part_file_name](#part_file_name-property-mime-struct)
- [part_headers](#part_headers-property-mime-struct)
- [part_name](#part_name-property-mime-struct)
- [part_size](#part_size-property-mime-struct)

The array indices start at *0* and end at *part_count - 1*.

## Data Type

i32

# part_content_disposition property ([MIME](#struct-ipworkspgpmime) Struct)

This property contains content disposition for each part.

## Syntax

*Rust Syntax*

```text
fn part_content_disposition(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_content_disposition(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_content_disposition_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## 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 struct fills it out each time the [part_decoded_file](#part_decoded_file-property-mime-struct) is changed. Changing the [part_content_disposition](#part_content_disposition-property-mime-struct) recalculates the [part_headers](#part_headers-property-mime-struct) as well.

The *PartIdx* parameter specifies the index of the item in the array. The size of the array is controlled by the [PartCount](#part_count-property-mime-struct) property.

## Data Type

String

# part_content_disposition_attr property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn part_content_disposition_attr(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_content_disposition_attr(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_content_disposition_attr_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## 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 [part_headers](#part_headers-property-mime-struct).

The *PartIdx* parameter specifies the index of the item in the array. The size of the array is controlled by the [PartCount](#part_count-property-mime-struct) property.

## Data Type

String

# part_content_id property ([MIME](#struct-ipworkspgpmime) Struct)

This property contains the content identifier for each part.

## Syntax

*Rust Syntax*

```text
fn part_content_id(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_content_id(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_content_id_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## 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 struct fills it out each time the [part_decoded_file](#part_decoded_file-property-mime-struct) is changed. Changing this property recalculates the [part_headers](#part_headers-property-mime-struct) as well.

The *PartIdx* parameter specifies the index of the item in the array. The size of the array is controlled by the [PartCount](#part_count-property-mime-struct) property.

## Data Type

String

# part_content_type property ([MIME](#struct-ipworkspgpmime) Struct)

This property contains the content type for each part.

## Syntax

*Rust Syntax*

```text
fn part_content_type(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_content_type(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_content_type_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## 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 struct fills it out each time the [part_decoded_file](#part_decoded_file-property-mime-struct) is changed. Changing this property recalculates the [part_headers](#part_headers-property-mime-struct) as well.

The *PartIdx* parameter specifies the index of the item in the array. The size of the array is controlled by the [PartCount](#part_count-property-mime-struct) property.

## Data Type

String

# part_content_type_attr property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn part_content_type_attr(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_content_type_attr(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_content_type_attr_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

This property contains the content-type attribute, if any, for each part. Setting this recalculates the [part_headers](#part_headers-property-mime-struct) as well.

The *PartIdx* parameter specifies the index of the item in the array. The size of the array is controlled by the [PartCount](#part_count-property-mime-struct) property.

## Data Type

String

# part_decoded_file property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn part_decoded_file(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_decoded_file(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_decoded_file_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

This property may be set to a file on disk before calling [encode_to_string](#encode_to_string-method-mime-struct), [encode_to_file](#encode_to_file-method-mime-struct) or [encode_to_stream](#MIME_m_EncodeToStream). When encoding, data for the part will be read from the specified file.

When decoding, call [decode_part_to_file](#decode_part_to_file-method-mime-struct) 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](#part_count-property-mime-struct) property.

## Data Type

String

# part_decoded_string property ([MIME](#struct-ipworkspgpmime) Struct)

This property holds the actual content of each part.

## Syntax

*Rust Syntax*

```text
fn part_decoded_string(&self , PartIdx : i32) -> Result<Vec<u8>, IPWorksPGPError> fn set_part_decoded_string(&self, PartIdx : i32, value : Vec<u8>) ->  Option<IPWorksPGPError>
fn set_part_decoded_string_ref(&self, PartIdx : i32, value : &[u8]) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

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

Setting a value to [part_decoded_string](#part_decoded_string-property-mime-struct) fills out the corresponding [part_size](#part_size-property-mime-struct) with the string size if the corresponding [part_decoded_file](#part_decoded_file-property-mime-struct) is empty.

The struct checks during encoding first [part_decoded_file](#part_decoded_file-property-mime-struct): if it is empty, then the struct uses the value of [part_decoded_string](#part_decoded_string-property-mime-struct).

NOTE: It is recommended to use the [decode_part](#decode_part-method-mime-struct) 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](#part_count-property-mime-struct) property.

## Data Type

Vec

# part_encoding property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn part_encoding(&self , PartIdx : i32) -> Result<i32, IPWorksPGPError> fn set_part_encoding(&self, PartIdx : i32, value : i32) ->  Option<IPWorksPGPError>
```

## Possible Values

```text
0   // 7Bit1   // QuotedPrintable2   // Base643   // 8Bit4   // Binary5   // UUEncode
```

## Default Value

0

## 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](#message-property-mime-struct), as specified in the *Content-Transfer-Encoding* header.

Possible values for the this property 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. |

The *PartIdx* parameter specifies the index of the item in the array. The size of the array is controlled by the [PartCount](#part_count-property-mime-struct) property.

## Data Type

i32

# part_file_name property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn part_file_name(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_file_name(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_file_name_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

This property contains the filename attribute specified in the headers of the part. Changing the value of the corresponding [part_decoded_file](#part_decoded_file-property-mime-struct) automatically sets the [part_file_name](#part_file_name-property-mime-struct) and consequently the [part_headers](#part_headers-property-mime-struct).

The *PartIdx* parameter specifies the index of the item in the array. The size of the array is controlled by the [PartCount](#part_count-property-mime-struct) property.

## Data Type

String

# part_headers property ([MIME](#struct-ipworkspgpmime) Struct)

This property contains the headers for each MIME part.

## Syntax

*Rust Syntax*

```text
fn part_headers(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_headers(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_headers_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

This property contains the headers for each MIME part. The struct 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](#part_count-property-mime-struct) property.

## Data Type

String

# part_name property ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn part_name(&self , PartIdx : i32) -> Result<String, IPWorksPGPError> fn set_part_name(&self, PartIdx : i32, value : &str) ->  Option<IPWorksPGPError>
fn set_part_name_ref(&self, PartIdx : i32, value : &String) ->  Option<IPWorksPGPError>
```

## Default Value

""

## Remarks

This property contains the name given to a part, such as the filename. Changing the value of [part_decoded_file](#part_decoded_file-property-mime-struct) automatically sets the corresponding [part_name](#part_name-property-mime-struct) and consequently the [part_headers](#part_headers-property-mime-struct).

The *PartIdx* parameter specifies the index of the item in the array. The size of the array is controlled by the [PartCount](#part_count-property-mime-struct) property.

## Data Type

String

# part_size property ([MIME](#struct-ipworkspgpmime) Struct)

This property contains the size of the DecodedFile or DecodedString .

## Syntax

*Rust Syntax*

```text
fn part_size(&self , PartIdx : i32) -> Result<i32, IPWorksPGPError>
```

## Default Value

0

## Remarks

This property contains the size of the [part_decoded_file](#part_decoded_file-property-mime-struct) or [part_decoded_string](#part_decoded_string-property-mime-struct). If a non-empty value is assigned to [part_decoded_file](#part_decoded_file-property-mime-struct), then struct fills out the corresponding [part_size](#part_size-property-mime-struct) with the file size; if the file does not exist, an error occurs.

If the [part_decoded_file](#part_decoded_file-property-mime-struct) is empty and a value is assigned to [part_decoded_string](#part_decoded_string-property-mime-struct), then the corresponding [part_size](#part_size-property-mime-struct) 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](#part_count-property-mime-struct) property.

This property is read-only.

## Data Type

i32

# config method ([MIME](#struct-ipworkspgpmime) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksPGPError>
```

## Remarks

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

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

# decode_from_file method ([MIME](#struct-ipworkspgpmime) Struct)

This method decodes from a file.

## Syntax

*Rust Syntax*

```text
fn decode_from_file(&self) -> Result<(), IPWorksPGPError>
```

## Remarks

This method decodes the data file given in [message](#message-property-mime-struct) and optionally message_headers and fills out the parts properties 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 message_headers property must be set to the appropriate MIME headers.

# decode_from_string method ([MIME](#struct-ipworkspgpmime) Struct)

This method decodes from a string.

## Syntax

*Rust Syntax*

```text
fn decode_from_string(&self) -> Result<(), IPWorksPGPError>
```

## Remarks

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

This method decodes the data given in [message](#message-property-mime-struct) and optionally message_headers and fills out the parts properties.

**Example. Decoding a Mail Message:**

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

# decode_part method ([MIME](#struct-ipworkspgpmime) Struct)

This method decodes the specified part.

## Syntax

*Rust Syntax*

```text
fn decode_part(&self, index : i32) ->  Result<Vec<u8>, IPWorksPGPError>
```

## Remarks

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

[decode_from_string](#decode_from_string-method-mime-struct) or [decode_from_file](#decode_from_file-method-mime-struct) must be called before calling this method. Calling this method will return the decoded bytes, and in addition, the [part_decoded_string](#part_decoded_string-property-mime-struct) property 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);
```

# decode_part_to_file method ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn decode_part_to_file(&self, index : i32) ->  Result<String, IPWorksPGPError>
```

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

[decode_from_string](#decode_from_string-method-mime-struct) or [decode_from_file](#decode_from_file-method-mime-struct) must be called before calling this method.

# encode_to_file method ([MIME](#struct-ipworkspgpmime) Struct)

This method encodes to a file.

## Syntax

*Rust Syntax*

```text
fn encode_to_file(&self) -> Result<(), IPWorksPGPError>
```

## Remarks

This method encodes the data given in parts properties (either a decoded file or a decoded string) into a MIME message at [message](#message-property-mime-struct) and message_headers 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 struct 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](#message-property-mime-struct); the message headers will be held by message_headers.

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

# encode_to_string method ([MIME](#struct-ipworkspgpmime) Struct)

This method encodes to a string.

## Syntax

*Rust Syntax*

```text
fn encode_to_string(&self) -> Result<(), IPWorksPGPError>
```

## Remarks

This method encodes to a string. It is the same as [encode_to_file](#encode_to_file-method-mime-struct) but the encoded data are held in the [message](#message-property-mime-struct) 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](#message-property-mime-struct) and message_headers 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 [reset_data](#reset_data-method-mime-struct).

The struct 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](#message-property-mime-struct) property; the message headers will be held by message_headers.

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

# reset method ([MIME](#struct-ipworkspgpmime) Struct)

This method will reset the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksPGPError>
```

## Remarks

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

# reset_data method ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
fn reset_data(&self) -> Result<(), IPWorksPGPError>
```

## Remarks

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

# on_error event ([MIME](#struct-ipworkspgpmime) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// MIMEErrorEventArgs carries the MIME Error event's parameters.
pub struct MIMEErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// MIMEErrorEvent defines the signature of the MIME Error event's handler function.
pub trait MIMEErrorEvent {
  fn on_error(&self, sender : MIME, e : &mut MIMEErrorEventArgs);
}

impl <'a> MIME<'a> {
  pub fn on_error(&self) -> &'a dyn MIMEErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn MIMEErrorEvent);
  ...
}
```

## Remarks

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

The *error_code* 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-struct) section.

# on_header event ([MIME](#struct-ipworkspgpmime) Struct)

This event is fired every time a header is parsed.

## Syntax

*Rust Syntax*

```text
// MIMEHeaderEventArgs carries the MIME Header event's parameters.
pub struct MIMEHeaderEventArgs {
  fn part_index(&self) -> i32
  fn field(&self) -> &String
  fn value(&self) -> &[u8]
}

// MIMEHeaderEvent defines the signature of the MIME Header event's handler function.
pub trait MIMEHeaderEvent {
  fn on_header(&self, sender : MIME, e : &mut MIMEHeaderEventArgs);
}

impl <'a> MIME<'a> {
  pub fn on_header(&self) -> &'a dyn MIMEHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn MIMEHeaderEvent);
  ...
}
```

## Remarks

The *part_index* 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 on_header event is fired when a header is parsed, which occurs for each header of the message when [decode_from_file](#decode_from_file-method-mime-struct), [decode_from_string](#decode_from_string-method-mime-struct), or decode_from_stream is called.

# on_progress event ([MIME](#struct-ipworkspgpmime) Struct)

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

## Syntax

*Rust Syntax*

```text
// MIMEProgressEventArgs carries the MIME Progress event's parameters.
pub struct MIMEProgressEventArgs {
  fn percent_done(&self) -> i32
}

// MIMEProgressEvent defines the signature of the MIME Progress event's handler function.
pub trait MIMEProgressEvent {
  fn on_progress(&self, sender : MIME, e : &mut MIMEProgressEventArgs);
}

impl <'a> MIME<'a> {
  pub fn on_progress(&self) -> &'a dyn MIMEProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn MIMEProgressEvent);
  ...
}
```

## Remarks

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

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

# Config Settings ([MIME](#struct-ipworkspgpmime) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-mime-struct) 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 struct whether to include the headers when encoding the message.If True, the struct will include the headers when [encode_to_file](#encode_to_file-method-mime-struct) or [encode_to_string](#encode_to_string-method-mime-struct) are called. If False, only the message will be encoded.

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

**RequireVersionHeader**: Specifies whether or not the struct should require the version header.If True, the struct will require that the "MIME-Version" header be included in the message_headers. 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 struct will replace invalid characters with an underscore when decoding the MIME message. This applies to the filename held in the [part_file_name](#part_file_name-property-mime-struct) property. 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 struct 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*.

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

Setting this configuration setting to *true* tells the struct 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](#struct-ipworkspgpmime) Struct)

### 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 struct is busy. |
| 285 | Can't create a temporary file to decode the data. |
| 286 | Can't read [message](#message-property-mime-struct) file. |
| 287 | No header separator found. |
| 289 | No separator found. |
| 290 | Input stream must have seeking enabled. |