Cloud Mail 2020 Node.js Edition

Questions / Feedback?

ListMessagesMarker Property

The page marker for listing folders.

Syntax

 office365.getListMessagesMarker([callback])
 office365.setListMessagesMarker( listMessagesMarker, [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 getListMessagesMarker([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 setListMessagesMarker([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 if there are still unlisted messages after ListMessages is called. It contains the nextLink that will be included as an OData parameter if ListMessages is called again on the same folder. This will cause the next page of messages to be listed.

Example (List All Message in a Folder)


do
  {
    office365.ListMessages(folderId);
  } while (office365.ListMessagesMarker.Length > 0);

This property is not available at design time.

Data Type

String

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Node.js Edition - Version 20.0 [Build 7718]