IP*Works! OpenPGP V9 - Online Help
IP*Works! OpenPGP V9
Questions / Feedback?

MessageNumber Property

Current (selected) message.

Syntax

 ppop.getMessageNumber([callback])
 ppop.setMessageNumber( messageNumber, [callback])

Default Value

1


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 getMessageNumber([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 setMessageNumber([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 indicates the current/selected message. This property specifies a message number in between 1 and MessageCount. The various class methods related to single messages use this property as a message pointer (see method descriptions and the MessageSize property).

Data Type

Long

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0