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

RecentMessageCount Property

Number of new messages in the Mailbox .

Syntax

 imap.getRecentMessageCount([callback])

Default Value

0


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 getRecentMessageCount([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 setRecentMessageCount([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 the number of new messages that are in the Mailbox. The class fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

Data Type

Long

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0