MessageHeaderField Property

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

Syntax

 mime.getMessageHeaderField(index, [callback])
 mime.setMessageHeaderField(index,  messageHeaderField, [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 getMessageHeaderField([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setMessageHeaderField([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 contains the name of the HTTP header (same case as it is delivered).

The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String