Upload Folder State
Applies to: Outlook 2013 | Outlook 2016
This topic describes what happens during the upload folder state of the replication state machine.
Quick info
| Property | Value |
|---|---|
| State Identifier: |
LR_SYNC_UPLOAD_FOLDER |
| Related Data Structure: |
UPFLD |
| From this state: |
Upload hierarchy state |
| To this state: |
Upload hierarchy state |
Note
The replication state machine is a deterministic state machine. A client departing from one state to another must eventually return to the former from the latter.
Description
This state initiates uploading a folder in a hierarchy that has been specified in a preceding upload hierarchy state. During this state, Outlook provides the folder object (if it has not been deleted) and the flags indicating the state of the folder (new, moved, modified, or deleted) as part of the corresponding UPFLD data structure. The client then uploads this information to the server.
If the upload is successful, the client sets ulFlags in UPFLD to UPF_OK. Outlook then clears its internal information about the request to upload the folder.
When the folder upload ends, the local store returns to the upload hierarchy state. Based on the UPHIER structure corresponding to the preceding upload hierarchy state, Outlook determines whether to proceed with uploading the next folder and to prepare for the next upload folder state.
Note
If the client needs to upload only one folder, the client can initiate the replication through the synchronize state without entering the upload hierarchy state. The client sets certain members of SYNC — ulFlags to UPS_UPLOAD_ONLY and UPS_ONE_FOLDER and feid to the folder's ID — to tell Outlook that only one folder will be uploaded.
See also
About the Replication API
MAPI Constants
About the Replication State Machine
SYNCSTATE