ListChanges Method

Lists messages that have been changed within a specified folder.

Object Oriented Interface

public function doListChanges($id, $maxpagesize);

Procedural Interface

cloudmail_office365_do_listchanges($res, $id, $maxpagesize);

Remarks

This method lists changed messages within the folder specified by id.

Starting from a Baseline State

For most use-cases, it is necessary to obtain a baseline state first in order to only list messages that have been changed after the baseline state was established.

To obtain a baseline state, ensure that both ChangeMarker and NextChangeMarker are empty, and then call ListChanges. Then follow the process described in the "General Usage" section (below) until ChangeMarker is empty to list all the changed messages.

General Usage

When this method is called, it will use the change marker stored in either ChangeMarker or NextChangeMarker (only one can be populated at a time) to request the next page of changes. This method causes the MessageList event to fire once for each change, and will also populate MessageInfo.

If there are still more messages available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in MessageInfo (Once there aren't any more changed messages available to list, the NextChangeMarker property will be populated instead).

When NextChangeMarker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)

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