PartDecodedString Property

This property holds the actual content of each part.

Syntax

 mime.getPartDecodedString(index, [callback])
 mime.setPartDecodedString(index,  partDecodedString_Buffer, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getPartDecodedString([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setPartDecodedString([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

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.

The index 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

Buffer