IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

MessageHeadersString Property

String version of the MIME message headers.

Syntax

 mime.getMessageHeadersString([callback])
 mime.setMessageHeadersString( messageHeadersString, [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 getMessageHeadersString([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 setMessageHeadersString([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 component fills out MessageHeadersString upon encoding. The user should use them 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

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