MIME Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorks_MIME

Procedural Interface

 ipworks_mime_open();
 ipworks_mime_close($res);
 ipworks_mime_register_callback($res, $id, $function);
 ipworks_mime_get_last_error($res);
 ipworks_mime_get_last_error_code($res);
 ipworks_mime_set($res, $id, $index, $value);
 ipworks_mime_get($res, $id, $index);
 ipworks_mime_do_config($res, $configurationstring);
 ipworks_mime_do_decodefromfile($res);
 ipworks_mime_do_decodefromstring($res);
 ipworks_mime_do_decodepart($res, $index);
 ipworks_mime_do_decodeparttofile($res, $index);
 ipworks_mime_do_encodetofile($res);
 ipworks_mime_do_encodetostring($res);
 ipworks_mime_do_reset($res);
 ipworks_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 that holds the encoded data. The decoded data are provided in Parts properties.

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

Calling the DecodeFromString or DecodeFromFile to decode does not actually decode the message but only parses it. The real decoding is done when the part content in the Parts properties is first accessed.

To encode data into a MIME message, you should first assign values for each part to either a part-decoded string or a part- decoded file in the Parts properties property, and optionally assign values to the other part attributes in the Parts properties. Assigning a value to the part-decoded string or a part-decoded file through the Parts properties, fills out automatically the part headers into the Parts properties for the respective part. Calling EncodeToFile or EncodeToString directs the 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 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.

Method List

---

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

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.

Config Settings

---

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

Boundary Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getBoundary();
public function setBoundary($value);

Procedural Interface

ipworks_mime_get($res, 1 );
ipworks_mime_set($res, 1, $value );

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 (IPWorks_MIME Class)

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

Object Oriented Interface

public function getContentType();
public function setContentType($value);

Procedural Interface

ipworks_mime_get($res, 2 );
ipworks_mime_set($res, 2, $value );

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. 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 (IPWorks_MIME Class)

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

Object Oriented Interface

public function getContentTypeAttr();
public function setContentTypeAttr($value);

Procedural Interface

ipworks_mime_get($res, 3 );
ipworks_mime_set($res, 3, $value );

Default Value

''

Remarks

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

Data Type

String

Message Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getMessage();
public function setMessage($value);

Procedural Interface

ipworks_mime_get($res, 4 );
ipworks_mime_set($res, 4, $value );

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 during encoding. The user may assign both the headers and the body to this property and leave MessageHeaders empty before decoding.

This property is not available at design time.

Data Type

Binary String

MessageHeaderCount Property (IPWorks_MIME Class)

The number of records in the MessageHeader arrays.

Object Oriented Interface

public function getMessageHeaderCount();
public function setMessageHeaderCount($value);

Procedural Interface

ipworks_mime_get($res, 5 );
ipworks_mime_set($res, 5, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageHeaderField
• MessageHeaderValue

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

This property is not available at design time.

Data Type

Integer

MessageHeaderField Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getMessageHeaderField($messageheaderindex);
public function setMessageHeaderField($messageheaderindex, $value);

Procedural Interface

ipworks_mime_get($res, 6 , $messageheaderindex);
ipworks_mime_set($res, 6, $value , $messageheaderindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

MessageHeaderValue Property (IPWorks_MIME Class)

This property contains the header contents.

Object Oriented Interface

public function getMessageHeaderValue($messageheaderindex);
public function setMessageHeaderValue($messageheaderindex, $value);

Procedural Interface

ipworks_mime_get($res, 7 , $messageheaderindex);
ipworks_mime_set($res, 7, $value , $messageheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

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

This property is not available at design time.

Data Type

String

MessageHeadersString Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getMessageHeadersString();
public function setMessageHeadersString($value);

Procedural Interface

ipworks_mime_get($res, 8 );
ipworks_mime_set($res, 8, $value );

Default Value

''

Remarks

The component fills out MessageHeadersString upon encoding. The user should use these strings as additional headers when emailing the Message.

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

Data Type

String

PartCount Property (IPWorks_MIME Class)

The number of records in the Part arrays.

Object Oriented Interface

public function getPartCount();
public function setPartCount($value);

Procedural Interface

ipworks_mime_get($res, 9 );
ipworks_mime_set($res, 9, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

PartContentDisposition Property (IPWorks_MIME Class)

This property contains content disposition for each part.

Object Oriented Interface

public function getPartContentDisposition($partidx);
public function setPartContentDisposition($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 10 , $partidx);
ipworks_mime_set($res, 10, $value , $partidx);

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 class fills it out each time the PartDecodedFile is changed. Changing the PartContentDisposition recalculates the PartHeaders as well.

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

This property is not available at design time.

Data Type

String

PartContentDispositionAttr Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getPartContentDispositionAttr($partidx);
public function setPartContentDispositionAttr($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 11 , $partidx);
ipworks_mime_set($res, 11, $value , $partidx);

Default Value

''

Remarks

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

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

Setting this property recalculates the PartHeaders.

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

This property is not available at design time.

Data Type

String

PartContentId Property (IPWorks_MIME Class)

This property contains the content identifier for each part.

Object Oriented Interface

public function getPartContentId($partidx);
public function setPartContentId($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 12 , $partidx);
ipworks_mime_set($res, 12, $value , $partidx);

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 class fills it out each time the PartDecodedFile is changed. Changing this property recalculates the PartHeaders as well.

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

This property is not available at design time.

Data Type

String

PartContentType Property (IPWorks_MIME Class)

This property contains the content type for each part.

Object Oriented Interface

public function getPartContentType($partidx);
public function setPartContentType($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 13 , $partidx);
ipworks_mime_set($res, 13, $value , $partidx);

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 class fills it out each time the PartDecodedFile is changed. Changing this property recalculates the PartHeaders as well.

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

This property is not available at design time.

Data Type

String

PartContentTypeAttr Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getPartContentTypeAttr($partidx);
public function setPartContentTypeAttr($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 14 , $partidx);
ipworks_mime_set($res, 14, $value , $partidx);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

PartDecodedFile Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function setPartDecodedFile($partidx, $value);

Procedural Interface

ipworks_mime_set($res, 15, $value , $partidx);

Default Value

''

Remarks

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

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

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

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

Data Type

String

PartDecodedString Property (IPWorks_MIME Class)

This property holds the actual content of each part.

Object Oriented Interface

public function getPartDecodedString($partidx);
public function setPartDecodedString($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 16 , $partidx);
ipworks_mime_set($res, 16, $value , $partidx);

Default Value

''

Remarks

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

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

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

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

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

This property is not available at design time.

Data Type

Binary String

PartEncoding Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getPartEncoding($partidx);
public function setPartEncoding($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 17 , $partidx);
ipworks_mime_set($res, 17, $value , $partidx);

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, as specified in the Content-Transfer-Encoding header.

Possible values for the this property are as follows:

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

This property is not available at design time.

Data Type

Integer

PartFileName Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getPartFileName($partidx);
public function setPartFileName($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 18 , $partidx);
ipworks_mime_set($res, 18, $value , $partidx);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

PartHeaders Property (IPWorks_MIME Class)

This property contains the headers for each MIME part.

Object Oriented Interface

public function getPartHeaders($partidx);
public function setPartHeaders($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 19 , $partidx);
ipworks_mime_set($res, 19, $value , $partidx);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

PartName Property (IPWorks_MIME Class)

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

Object Oriented Interface

public function getPartName($partidx);
public function setPartName($partidx, $value);

Procedural Interface

ipworks_mime_get($res, 20 , $partidx);
ipworks_mime_set($res, 20, $value , $partidx);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

PartSize Property (IPWorks_MIME Class)

This property contains the size of the DecodedFile or DecodedString .

Object Oriented Interface

public function getPartSize($partidx);

Procedural Interface

ipworks_mime_get($res, 22 , $partidx);

Default Value

0

Remarks

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

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

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

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

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

Data Type

Integer

Config Method (IPWorks_MIME Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_mime_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

DecodeFromFile Method (IPWorks_MIME Class)

This method decodes from a file.

Object Oriented Interface

public function doDecodeFromFile();

Procedural Interface

ipworks_mime_do_decodefromfile($res);

Remarks

This method decodes the data file given in Message and optionally MessageHeaders and fills out the Parts properties for each decoded part.

Example. Decoding from a File:

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

In this example, C:\filename.txt must contain the MIME headers and body. If not, the MessageHeaders property must be set to the appropriate MIME headers.

DecodeFromString Method (IPWorks_MIME Class)

This method decodes from a string.

Object Oriented Interface

public function doDecodeFromString();

Procedural Interface

ipworks_mime_do_decodefromstring($res);

Remarks

This method decodes from a string. It is the same as DecodeFromFile, but now the Message denotes the real encoded message rather than a filename.

This method decodes the data given in Message and optionally MessageHeaders and fills out the Parts properties.

Example. Decoding a Mail Message:

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

DecodePart Method (IPWorks_MIME Class)

This method decodes the specified part.

Object Oriented Interface

public function doDecodePart($index);

Procedural Interface

ipworks_mime_do_decodepart($res, $index);

Remarks

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

DecodeFromString or DecodeFromFile must be called before calling this method. Calling this method will return the decoded bytes, and in addition, the PartDecodedString property will be populated with the string representation of the decoded data.

Example. Decoding a Specified Part: mime.MessageHeadersString = myMessageHeaders; mime.Message = myMessageBody; mime.DecodeFromString(); byte[] myPartContent = await mime.DecodePart(0);

DecodePartToFile Method (IPWorks_MIME Class)

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

Object Oriented Interface

public function doDecodePartToFile($index);

Procedural Interface

ipworks_mime_do_decodeparttofile($res, $index);

Remarks

This method decodes the part specified by Index to a temporary file. The full path to the temporary file is returned by this method. The user is responsible for deleting the temporary file.

DecodeFromString or DecodeFromFile must be called before calling this method.

EncodeToFile Method (IPWorks_MIME Class)

This method encodes to a file.

Object Oriented Interface

public function doEncodeToFile();

Procedural Interface

ipworks_mime_do_encodetofile($res);

Remarks

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

The class will check for each item in Parts properties (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be saved in the file pointed to by Message; the message headers will be held by MessageHeaders.

Example. Encoding Data:

MIMEControl.ResetData() MIMEControl.PartCount = 2 MIMEControl.PartDecodedString(0) = "This is plain text data" MIMEControl.PartEncoding(0) = peQuotedPrintable MIMEControl.PartContentType(0) = "text/plain" MIMEControl.PartDecodedFile(1) = "C:\filename.txt" MIMEControl.Message = "temp.tmp" MIMEControl.EncodeToFile()

EncodeToString Method (IPWorks_MIME Class)

This method encodes to a string.

Object Oriented Interface

public function doEncodeToString();

Procedural Interface

ipworks_mime_do_encodetostring($res);

Remarks

This method encodes to a string. It is the same as EncodeToFile but the encoded data are held in the Message property rather than saved to a file.

This method encodes the data given in the Parts properties into a MIME message. The message gets stored in Message and MessageHeaders using the values optionally given in Parts properties. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts properties by calling ResetData.

The class will check each item in the Parts properties (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be stored in the Message property; the message headers will be held by MessageHeaders.

Example. Encoding Data:

MIMEControl.ResetData() MIMEControl.PartCount = 2 MIMEControl.PartDecodedString(0) = "This is plain text data" MIMEControl.PartEncoding(0) = peQuotedPrintable MIMEControl.PartContentType(0) = "text/plain" MIMEControl.PartDecodedFile(1) = "C:\filename.txt" MIMEControl.EncodeToString()

Reset Method (IPWorks_MIME Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_mime_do_reset($res);

Remarks

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

ResetData Method (IPWorks_MIME Class)

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

Object Oriented Interface

public function doResetData();

Procedural Interface

ipworks_mime_do_resetdata($res);

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 Event (IPWorks_MIME Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_mime_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

Header Event (IPWorks_MIME Class)

This event is fired every time a header is parsed.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworks_mime_register_callback($res, 2, array($this, 'fireHeader'));

Parameter List

 'partindex'
 'field'
 'value'

Remarks

The PartIndex parameter contains the index of the part containing the current header. If the header is from the MIME body, this value will be -1. The Field parameter contains the name of the MIME header. The Value parameter contains the header contents. The Header event is fired when a header is parsed, which occurs for each header of the message when DecodeFromFile, DecodeFromString, or DecodeFromStream is called.

Progress Event (IPWorks_MIME Class)

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

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworks_mime_register_callback($res, 3, array($this, 'fireProgress'));

Parameter List

 'percentdone'

Remarks

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

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

Config Settings (MIME 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 method.

MIME Config Settings

Base Config Settings

Trappable Errors (MIME Class)

MIME Errors