IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

PeekMode Property

When set to True, the message Seen flag is not changed during reading.

Syntax

 pimap.getPeekMode([callback])
 pimap.setPeekMode( peekMode, [callback])

Default Value

FALSE

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 getPeekMode([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 setPeekMode([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 a true or false to determine whether or not this message should be seen. When this property is set to True, a "PEEK" option is added to all IMAP FETCH commands sent to the server. An RFC compliant IMAP server should not set the "Seen" flag on the message in this case.

This property is not available at design time.

Data Type

Boolean

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