MIME Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorksOpenPGP_MIME

Procedural Interface

 ipworksopenpgp_mime_open();
 ipworksopenpgp_mime_close($res);
 ipworksopenpgp_mime_register_callback($res, $id, $function);
 ipworksopenpgp_mime_get_last_error($res);
 ipworksopenpgp_mime_get_last_error_code($res);
 ipworksopenpgp_mime_set($res, $id, $index, $value);
 ipworksopenpgp_mime_get($res, $id, $index);
 ipworksopenpgp_mime_do_config($res, $configurationstring);
 ipworksopenpgp_mime_do_decodefromfile($res);
 ipworksopenpgp_mime_do_decodefromstring($res);
 ipworksopenpgp_mime_do_encodetofile($res);
 ipworksopenpgp_mime_do_encodetostring($res);
 ipworksopenpgp_mime_do_resetdata($res);

Remarks

The class may be used for decoding or encoding of messages. Message holds the content of the encoded message or the filename which holds the encoded data. The decoded data is provided in Parts properties.

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

Calling the DecodeFromString or DecodeFromFile to decode doesn't 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 part decoded string or 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 part decoded file through the Parts properties, fills out automatically the part headers into the Parts properties for the respective part. Calling EncodeToFile or EncodeToString directs the class to fill out the Message with the message body and the MessageHeaders with the headers.

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