Ruby
Ruby
Outlook -- Move Messages from One Folder to Another
See more Outlook Examples
Demonstrates how to move messages from one folder to another.Chilkat Ruby Downloads
require 'chilkat'
success = false
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use your previously obtained access token here:
http.put_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 = Chilkat::CkHashtable.new()
sbMap = Chilkat::CkStringBuilder.new()
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.get_LastMethodSuccess() != true)
print "Folder ID not found" + "\n";
exit
end
dstFolderId = htFolderMap.lookupStr("/Inbox/abc/subFolderB")
if (htFolderMap.get_LastMethodSuccess() != true)
print "Folder ID not found" + "\n";
exit
end
success = true
json = Chilkat::CkJsonObject.new()
json.put_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 = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
json.LoadSb(sbResponse)
# Show the results..
print json.emit() + "\n";
# 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 = Chilkat::CkJsonObject.new()
jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.put_EmitCompact(false)
i = 0
numEmails = json.SizeOfArray("value")
while i < numEmails
json.put_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 + "\n";
# Move the message to the destination folder
resp = Chilkat::CkHttpResponse.new()
success = http.HttpJson("POST","https://graph.microsoft.com/v1.0/me/messages/{$message_id}/move",jsonRequestBody,"application/json",resp)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
# A 200 response indicates success.
if (http.get_LastStatus() == 200)
print "Message moved." + "\n";
else
print "Response status code = " + resp.get_StatusCode().to_s() + "\n";
print "Error: Message not moved." + "\n";
end
# Show the response in both cases..
jsonResponse.Load(resp.bodyStr())
print jsonResponse.emit() + "\n";
i = i + 1
end
# ---------------------------------------------------
# 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": [
# ]
# }
#