The MIME class allows for the simple encoding and decoding of MIME structures such as message attachments, file uploads, etc.
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 message_headers property and the message body or the filename holding it into the message property. Calling decode_from_file or decode_from_string directs the class to start parsing the message: it will fill out the content_type, content_type_attr 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 decode_from_string or decode_from_file 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 encode_to_file or encode_to_string directs the class to fill out the message with the message body and the message_headers with the headers.
The on_progress event is fired as the message is parsed and the data is decoded/encoded.
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
|boundary||The boundary separating the MIME parts. Maximum length of 80 bytes.|
|content_type||The value of the content-type header of the message which was encoded/decoded.|
|content_type_attr||The attributes for content-type header of the message which was encoded/decoded.|
|message||Contains the encoded message text or a path to a file which contains the encoded message text.|
|message_header_count||The number of records in the MessageHeader arrays.|
|message_header_field||This property contains the name of the HTTP header (same case as it is delivered).|
|message_header_value||This property contains the header contents.|
|message_headers_string||String version of the MIME message headers.|
|part_count||The number of records in the Part arrays.|
|part_content_disposition||Content disposition for each part.|
|part_content_disposition_attr||The content disposition's attribute (if any) for each part.|
|part_content_id||Content identifier for each part.|
|part_content_type||Content type for each part.|
|part_content_type_attr||The content type attribute, if any, for each part.|
|part_decoded_file||The filename with the decoded data.|
|part_decoded_string||This property holds the actual content of each part.|
|part_encoding||This property contains the actual content encoding type for each part.|
|part_filename||This property contains the filename attribute specified in the headers of the part.|
|part_headers||This property contains the headers for each MIME part.|
|part_name||This property contains the name given to a part, such as the filename.|
|part_size||This property contains the size of the DecodedFile or DecodedString .|
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
|config||Sets or retrieves a configuration setting.|
|decode_from_file||Decodes from file.|
|decode_from_string||Decodes from string.|
|encode_to_file||Encodes to file.|
|encode_to_string||Encodes to string.|
|reset||Reset the class.|
|reset_data||Resets the values of all headers and Part- properties.|
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
|on_error||Information about errors during data delivery.|
|on_header||Fired every time a header is parsed.|
|on_progress||Shows the progress of decoding/encoding the input data.|
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
|DecodeMessageHeaders||Instructs the class to automatically decode message headers.|
|IncludeHeaders||Tells the class whether to include the headers when encoding the message.|
|RequireVersionHeader||Specifies whether or not the class should require the version header.|
|SanitizeFilename||Whether invalid characters are replaced in MIME part filenames.|
|TempFilePath||If set, the temporary files created during MIME decoding and encoding will be put in the path specified.|
|BuildInfo||Information about the product's build.|
|CodePage||The system code page used for Unicode to Multibyte translations.|
|LicenseInfo||Information about the current license.|
|ProcessIdleEvents||Whether the class uses its internal event loop to process events when the main thread is idle.|
|SelectWaitMillis||The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.|
|UseInternalSecurityAPI||Tells the class whether or not to use the system security libraries or an internal implementation.|