ListMessages Method

Lists the messages in a folder.

Syntax

int ListMessages(const QString& qsfolderId, const QString& qsfilter);

Remarks

This method lists the messages found in the specified folder. This method clears and populates the MessageInfo* properties.

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'");

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Mail 2020 Qt Edition - Version 20.0 [Build 8308]