Cloud Mail 2020 Node.js Edition

Questions / Feedback?

ListMessages Method

Lists the messages in a folder.

Syntax

office365.listMessages(folderId, filter, [callback])

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 this 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 method lists the messages found in the specified folder. This method populates the MessageInfo property.

If the number of messages is greater than the message page size, ListMessagesMarker will be populated and calling ListMessages again will list the next page of messages.

filter can be used to retrieve a specific subset of messages, or it can be left as an empty string to retrieve all messages in a folder. filter follows the OData protocol syntax.

Example (List All Messages in a Folder)


office365.ListMessages(folderId, "");

Example (List Unread Messages in a Folder)


office365.ListMessages(folderId, "isRead eq false");

Example (List Messages from a Specific Address)


office365.ListMessages(folderId, "address eq 'specific@address.com'");

Example (List Unread Messages from a Specific Address)


office365.ListMessages(folderId, "isRead eq false and address eq 'specific@address.com'");

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