(Chilkat2-Python) Outlook -- Move Messages from One Folder to Another

Demonstrates how to move messages from one folder to another.

Note: This example requires Chilkat v9.5.0.68 or greater.

Chilkat2 Python Downloads

install with pip
pip3 install chilkat2
or download... Python Module for Windows, Linux, Alpine Linux, MacOS, Solaris

import sys
import chilkat2

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

# Use your previously obtained access token here:
http.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

# This example will move some messages from /Inbox to /Inbox/abc/subFolderB
# We'll need the folder ids for both source and destination folders..

# Get the folder IDs from the folder map created by this example 
htFolderMap = chilkat2.Hashtable()
sbMap = chilkat2.StringBuilder()
sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
htFolderMap.AddFromXmlSb(sbMap)

# Get the IDs for the source and destination folders.
srcFolderId = htFolderMap.LookupStr("/Inbox")
if (htFolderMap.LastMethodSuccess != True):
    print("Folder ID not found")
    sys.exit()

dstFolderId = htFolderMap.LookupStr("/Inbox/abc/subFolderB")
if (htFolderMap.LastMethodSuccess != True):
    print("Folder ID not found")
    sys.exit()

success = True
json = chilkat2.JsonObject()
json.EmitCompact = False

# Search for emails in this folder with the words "sample" or "example" in the subject, and return only the id and subject.
http.SetUrlVar("folder_id",srcFolderId)
http.SetUrlVar("select","id,subject")
http.SetUrlVar("filter","contains(subject,'sample') or contains(subject,'example')")

sbResponse = chilkat2.StringBuilder()
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if (success != True):
    print(http.LastErrorText)
    sys.exit()

json.LoadSb(sbResponse)
# Show the results..
print(json.Emit())

# Sample results:

# 	{
# 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(id,subject)",
# 	  "value": [
# 	    {
# 	      "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfr\"",
# 	      "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj10AAAA=",
# 	      "subject": "A sample email with Amazon in the body"
# 	    },
# 	    {
# 	      "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfo\"",
# 	      "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1oAAAA=",
# 	      "subject": "This is an example email from chilkat.io"
# 	    }
# 	  ]
# 	}

# ------------
# Proceed to move (copy) each of the above emails to the destination folder.
jsonRequestBody = chilkat2.JsonObject()
jsonResponse = chilkat2.JsonObject()
jsonResponse.EmitCompact = False

i = 0
numEmails = json.SizeOfArray("value")
while i < numEmails :
    json.I = i

    messageId = json.StringOf("value[i].id")
    http.SetUrlVar("message_id",messageId)

    # Create a JSON request body with this content:
    # 
    # 		{
    # 		  "DestinationId": "destinationId-value"
    # 		}
    # 
    dstFolderId = htFolderMap.LookupStr("/Inbox/abc/subFolderB")
    jsonRequestBody.UpdateString("DestinationId",dstFolderId)
    print("Moving " + messageId)

    # Move the message to the destination folder
    # resp is a CkHttpResponse
    resp = http.PostJson2("https://graph.microsoft.com/v1.0/me/messages/{$message_id}/move","application/json",jsonRequestBody.Emit())
    if (http.LastMethodSuccess != True):
        print(http.LastErrorText)
        sys.exit()

    # A 200 response indicates success.
    if (http.LastStatus == 200):
        print("Message moved.")
    else:
        print("Response status code = " + str(resp.StatusCode))
        print("Error: Message not moved.")

    # Show the response in both cases..
    jsonResponse.Load(resp.BodyStr)
    print(jsonResponse.Emit())

    i = i + 1

# ---------------------------------------------------
# Sample output:

# Moving AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj2EAAAA=
# Message moved.
# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#message",
#   "@odata.type": "#microsoft.graph.message",
#   "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOp08j\"",
#   "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAADn68XtMop0TpsYJGpfKXY9AAAAzomk2wAAAA==",
#   "createdDateTime": "2017-05-30T23:39:35Z",
#   "lastModifiedDateTime": "2017-05-31T23:17:59Z",
#   "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOp08j",
#   "categories": [
#   ],
#   "receivedDateTime": "2017-05-30T23:39:35Z",
#   "sentDateTime": "2017-05-30T23:39:18Z",
#   "hasAttachments": false,
#   "internetMessageId": "<4aea73c1-2b29-f550-e6f1-eb22785a56f0@chilkatsoft.com>",
#   "subject": "A sample email with Amazon in the body",
#   "bodyPreview": "This email has the keyword Amazon in the body..",
#   "importance": "normal",
#   "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA=",
#   "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQADxkIFlCV-RFitsiVnh2MsI=",
#   "isDeliveryReceiptRequested": null,
#   "isReadReceiptRequested": false,
#   "isRead": false,
#   "isDraft": false,
#   "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huwMAAADn68XtMop0TpsYJGpfKXY9AAAAzomk2wAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
#   "inferenceClassification": "focused",
#   "body": {
#     "contentType": "html",
#     "content": "<html>...</html>\r\n"
#   },
#   "sender": {
#     "emailAddress": {
#       "name": "Chilkat Software",
#       "address": "support@chilkatsoft.com"
#     }
#   },
#   "from": {
#     "emailAddress": {
#       "name": "Chilkat Software",
#       "address": "support@chilkatsoft.com"
#     }
#   },
#   "toRecipients": [
#     {
#       "emailAddress": {
#         "name": "Chilkat Software",
#         "address": "chilkatsoft@outlook.com"
#       }
#     }
#   ],
#   "ccRecipients": [
#   ],
#   "bccRecipients": [
#   ],
#   "replyTo": [
#   ]
# }
# 
# Moving AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj2IAAAA=
# Message moved.
# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#message",
#   "@odata.type": "#microsoft.graph.message",
#   "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOp08k\"",
#   "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAADn68XtMop0TpsYJGpfKXY9AAAAzomk3AAAAA==",
#   "createdDateTime": "2017-05-30T21:07:18Z",
#   "lastModifiedDateTime": "2017-05-31T23:17:59Z",
#   "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOp08k",
#   "categories": [
#   ],
#   "receivedDateTime": "2017-05-30T21:07:18Z",
#   "sentDateTime": "2017-05-30T21:06:56Z",
#   "hasAttachments": false,
#   "internetMessageId": "<31fbbbce-2c70-c8d1-f0bd-35a7c7694a99@chilkat.io>",
#   "subject": "This is an example email from chilkat.io",
#   "bodyPreview": "This is an example email from chilkat.io",
#   "importance": "normal",
#   "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA=",
#   "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQAEa8sL3gJ_FNjgk2YkP1eTQ=",
#   "isDeliveryReceiptRequested": null,
#   "isReadReceiptRequested": false,
#   "isRead": true,
#   "isDraft": false,
#   "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huwMAAADn68XtMop0TpsYJGpfKXY9AAAAzomk3AAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
#   "inferenceClassification": "focused",
#   "body": {
#     "contentType": "html",
#     "content": "<html>...</html>\r\n"
#   },
#   "sender": {
#     "emailAddress": {
#       "name": "Chilkat Software",
#       "address": "admin@chilkat.io"
#     }
#   },
#   "from": {
#     "emailAddress": {
#       "name": "Chilkat Software",
#       "address": "admin@chilkat.io"
#     }
#   },
#   "toRecipients": [
#     {
#       "emailAddress": {
#         "name": "Chilkat Software",
#         "address": "chilkatsoft@outlook.com"
#       }
#     }
#   ],
#   "ccRecipients": [
#   ],
#   "bccRecipients": [
#   ],
#   "replyTo": [
#   ]
# }
#