(Tcl) 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.

This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# Use your previously obtained access token here:
CkHttp_put_AuthToken $http "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 
set htFolderMap [new_CkHashtable]

set sbMap [new_CkStringBuilder]

CkStringBuilder_LoadFile $sbMap "qa_data/outlook/folderMap.xml" "utf-8"
CkHashtable_AddFromXmlSb $htFolderMap $sbMap

# Get the IDs for the source and destination folders.
set srcFolderId [CkHashtable_lookupStr $htFolderMap "/Inbox"]
if {[CkHashtable_get_LastMethodSuccess $htFolderMap] != 1} then {
    puts "Folder ID not found"
    delete_CkHttp $http
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    exit
}

set dstFolderId [CkHashtable_lookupStr $htFolderMap "/Inbox/abc/subFolderB"]
if {[CkHashtable_get_LastMethodSuccess $htFolderMap] != 1} then {
    puts "Folder ID not found"
    delete_CkHttp $http
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    exit
}

set success 1
set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0

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

set sbResponse [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}" $sbResponse]
if {$success != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponse
    exit
}

CkJsonObject_LoadSb $json $sbResponse
# Show the results..
puts [CkJsonObject_emit $json]

# 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.
set jsonRequestBody [new_CkJsonObject]

set jsonResponse [new_CkJsonObject]

CkJsonObject_put_EmitCompact $jsonResponse 0

set i 0
set numEmails [CkJsonObject_SizeOfArray $json "value"]
while {$i < $numEmails} {
    CkJsonObject_put_I $json $i

    set messageId [CkJsonObject_stringOf $json "value[i].id"]
    CkHttp_SetUrlVar $http "message_id" $messageId

    # Create a JSON request body with this content:
    # 
    # 		{
    # 		  "DestinationId": "destinationId-value"
    # 		}
    # 
    set dstFolderId [CkHashtable_lookupStr $htFolderMap "/Inbox/abc/subFolderB"]
    CkJsonObject_UpdateString $jsonRequestBody "DestinationId" $dstFolderId
    puts "Moving $messageId"

    # Move the message to the destination folder
    # resp is a CkHttpResponse
    set resp [CkHttp_PostJson2 $http "https://graph.microsoft.com/v1.0/me/messages/{$message_id}/move" "application/json" [CkJsonObject_emit $jsonRequestBody]]
    if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
        puts [CkHttp_lastErrorText $http]
        delete_CkHttp $http
        delete_CkHashtable $htFolderMap
        delete_CkStringBuilder $sbMap
        delete_CkJsonObject $json
        delete_CkStringBuilder $sbResponse
        delete_CkJsonObject $jsonRequestBody
        delete_CkJsonObject $jsonResponse
        exit
    }

    # A 200 response indicates success.
    if {[CkHttp_get_LastStatus $http] == 200} then {
        puts "Message moved."
    }     else {
        puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
        puts "Error: Message not moved."
    }

    # Show the response in both cases..
    CkJsonObject_Load $jsonResponse [CkHttpResponse_bodyStr $resp]
    puts [CkJsonObject_emit $jsonResponse]

    delete_CkHttpResponse $resp

    set i [expr $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": [
#   ]
# }
# 

delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonRequestBody
delete_CkJsonObject $jsonResponse