IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

Message Property

Provides the raw message content.

Syntax

 pimap.getMessage([callback])
 pimap.setMessage( message_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 getMessage([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 setMessage([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 is populated after calling FetchMessagePart and holds the raw message content. This can be used to access the data before any processing is done by the class.

This property is not available at design time.

Data Type

Buffer

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