MS Graph API v1.0 - Navigating Multi-level Folders

Question

Hi,

I am trying to make an automated script in PHP that copies or moves mail to a user's mail folder using the Graph 1.0 API and the v1.82.0 msgraph-sdk-php SDK. The problem I am running into is that some folders I need to access are several folders deep and I am struggling to understand how to build a 'destination' to move or copy the mail to.

Example. I want to move message ID 123456789 to /Test2/Test22/Test222

I make a POST request to "/users/{id}/messages/{id}/move"

In the body I give a destinationId for the folder to move to, but I do no know what kind of GET request I need to make to traverse the folder structure to get the ID for the Test222 folder.

Can someone fill me in on how to do this?

Thanks.

Answer 1

Hello @Mark Benson

Thanks for reaching out!

You can list down the childFolders of a MailFolder using List ChildFolders endpoint. Endpoint: GET /me/mailFolders/{id}/childFolders

Using above endpoint, you'll get the ID of the childFolder in response and post that, you can replace the parentMailfolderID with the childFolderID in endpoint, which will further list the children of that childFolder. More precisely, you need to make multiple calls to get into the last child folder.

Please find the detailed steps below:

GET https://graph.microsoft.com/v1.0/me/mailFolders - will list all the mailFolders
GET https://graph.microsoft.com/v1.0/me/mailFolders/{mailFolderID} - get the MailFolder details
GET https://graph.microsoft.com/v1.0/me/mailFolders/{mailFolderID}/childFolders - List childFolders of MailFolder
GET https://graph.microsoft.com/v1.0/me/mailFolders/{childFolderID}/childFolders - mailFolderID replaced with childFolderID (Repeat until you reach the last childFolder)

Now use the last ChildFolderID as a destinationID in the request body of Move Messages Endpoint

Endpoint:

POST https://graph.microsoft.com/v1.0/me/messages/{message-id}/move  
Content-type: application/json  
  
{  
  "destinationId": "ChildFolderID"  
}  

Hope this helps.

If the answer is helpful, please click Accept Answer and kindly upvote. If you have any further questions about this answer, please click Comment.