SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

HeaderFieldValue Property

The value element in a (name, value) pair.

Syntax

 mailwriter.getHeaderFieldValue(index, [callback])
 mailwriter.setHeaderFieldValue(index,  headerFieldValue, [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 getHeaderFieldValue([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 setHeaderFieldValue([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

The value element in a (name, value) pair.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Node.js Edition - Version 20.0 [Build 8165]