Tcl Requires Chilkat v11.0.0+
Tcl
Outlook -- Create Reply Email, Update, and Send
See more Outlook Examples
Creates a reply email in the Drafts folder, updates the reply with information, and then sends the reply.Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# 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 search /Inbox for a message that will be replied to.
# First we need to get the folder ID for /Inbox.
# Then we'll search for messages based on some criteria, and reply to the 1st matching message.
# To reply, we'll create the reply message in the Drafts folder, update it with content, and the send.
# Get the folder ID for /Inbox 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 ID for the "/Inbox" folder:
set folderId [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 success 1
set json [new_CkJsonObject]
CkJsonObject_put_EmitCompact $json 0
# Search for unread emails in this folder from support@chilkatsoft.com
CkHttp_SetUrlVar $http "folder_id" $folderId
CkHttp_SetUrlVar $http "select" "id,subject"
CkHttp_SetUrlVar $http "filter" "(isRead eq false) and (from/emailAddress/address eq 'support@chilkatsoft.com')"
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 == 0} 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]
if {[CkJsonObject_SizeOfArray $json "value"] == 0} then {
puts "Empty result set."
delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
exit
}
# Sample results:
# {
# "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(id,subject)",
# "value": [
# {
# "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfq\"",
# "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1wAAAA=",
# "subject": "This email contains a PDF attachment"
# },
# {
# "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfs\"",
# "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj14AAAA=",
# "subject": "This email has the word Amazon in the subject.."
# }
# ]
# }
# We'll create a reply for the 1st message in the result set.
# We'll need the message existing id.
set existingMsgId [CkJsonObject_stringOf $json "value[0].id"]
# To create a reply, send a request such as the following:
# POST https://graph.microsoft.com/v1.0/me/messages/{id}/createReply
# Content-type: application/json
# Content-length: 248
#
# {
# "comment": "comment-value"
# }
set jsonRequestBody [new_CkJsonObject]
CkJsonObject_UpdateString $jsonRequestBody "comment" "This is a comment"
CkHttp_SetUrlVar $http "message_id" $existingMsgId
# Create the reply in the Drafts folder:
set resp [new_CkHttpResponse]
set success [CkHttp_HttpJson $http "POST" "https://graph.microsoft.com/v1.0/me/messages/{$message_id}/createReply" $jsonRequestBody "application/json" $resp]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonRequestBody
delete_CkHttpResponse $resp
exit
}
# A 201 response indicates success.
if {[CkHttpResponse_get_StatusCode $resp] == 201} then {
puts "Created reply draft."
set success 1
} else {
puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
puts "Failed to create reply draft."
set success 0
}
# Show the response in both cases..
set jsonResponse [new_CkJsonObject]
CkJsonObject_put_EmitCompact $jsonResponse 0
CkJsonObject_Load $jsonResponse [CkHttpResponse_bodyStr $resp]
puts [CkJsonObject_emit $jsonResponse]
if {$success == 0} then {
delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonRequestBody
delete_CkHttpResponse $resp
delete_CkJsonObject $jsonResponse
exit
}
# ----------------------------------------------
# Get the message id of the newly created reply.
set replyMsgId [CkJsonObject_stringOf $jsonResponse "id"]
# Update the message with new text in the body..
# Send an HTTP PATCH request that looks something like this:
# Only send the message parts that are changing.
# PATCH https://graph.microsoft.com/v1.0/me/messages/{reply_message_id}
# Content-type: application/json
# Content-length: 248
#
# {
# "subject": "subject-value",
# "body": {
# "contentType": "html",
# "content": "updated HTML goes here"
# },
# "inferenceClassification": "other"
# }
set jsonPatch [new_CkJsonObject]
CkJsonObject_UpdateString $jsonPatch "body.contentType" "html"
# The reply email that Outlook created will contain the original message under a horizontal rule.
# The body.content should contain this substring: "<body bgcolor=\"#FFFFFF\">\r\n<hr "
# We're going to insert our reply after the body tag, and before the hr tag.
set sbHtml [new_CkStringBuilder]
CkJsonObject_StringOfSb $jsonResponse "body.content" $sbHtml
# Insert the response HTML in the reply HTML body.
set numReplaced [CkStringBuilder_ReplaceBetween $sbHtml "<body bgcolor=\"#FFFFFF\">" "<hr " "\r\n" "<p>This is my response.</p>"]
if {$numReplaced != 1} then {
puts "Something is amiss!"
delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonRequestBody
delete_CkHttpResponse $resp
delete_CkJsonObject $jsonResponse
delete_CkJsonObject $jsonPatch
delete_CkStringBuilder $sbHtml
exit
}
CkJsonObject_UpdateString $jsonPatch "body.content" [CkStringBuilder_getAsString $sbHtml]
# Add additional CC, BCC, or TO recipients like this:
set numToRecipients [CkJsonObject_SizeOfArray $jsonResponse "toRecipients"]
set i 0
# Copy existing TO recipients.
while {$i < $numToRecipients} {
CkJsonObject_put_I $jsonPatch $i
CkJsonObject_put_I $jsonResponse $i
CkJsonObject_UpdateString $jsonPatch "toRecipients[i].emailAddress.name" [CkJsonObject_stringOf $jsonResponse "toRecipients[i].emailAddress.name"]
CkJsonObject_UpdateString $jsonPatch "toRecipients[i].emailAddress.address" [CkJsonObject_stringOf $jsonResponse "toRecipients[i].emailAddress.address"]
set i [expr $i + 1]
}
# Add an additional TO recipient.
CkJsonObject_put_I $jsonPatch $numToRecipients
CkJsonObject_UpdateString $jsonPatch "toRecipients[i].emailAddress.name" "Chilkat"
CkJsonObject_UpdateString $jsonPatch "toRecipients[i].emailAddress.address" "admin@chilkat.io"
set numCcRecipients [CkJsonObject_SizeOfArray $jsonResponse "ccRecipients"]
set i 0
# Copy existing CC recipients.
while {$i < $numCcRecipients} {
CkJsonObject_put_I $jsonPatch $i
CkJsonObject_put_I $jsonResponse $i
CkJsonObject_UpdateString $jsonPatch "ccRecipients[i].emailAddress.name" [CkJsonObject_stringOf $jsonResponse "ccRecipients[i].emailAddress.name"]
CkJsonObject_UpdateString $jsonPatch "ccRecipients[i].emailAddress.address" [CkJsonObject_stringOf $jsonResponse "ccRecipients[i].emailAddress.address"]
set i [expr $i + 1]
}
# Add an additional CC recipient.
CkJsonObject_put_I $jsonPatch $numCcRecipients
CkJsonObject_UpdateString $jsonPatch "ccRecipients[i].emailAddress.name" "Chilkat GMail"
CkJsonObject_UpdateString $jsonPatch "ccRecipients[i].emailAddress.address" "chilkat.support@gmail.com"
CkJsonObject_put_EmitCompact $jsonPatch 0
puts [CkJsonObject_emit $jsonPatch]
CkHttp_SetUrlVar $http "message_id" $replyMsgId
set success [CkHttp_HttpJson $http "PATCH" "https://graph.microsoft.com/v1.0/me/messages/{$message_id}" $jsonPatch "application/json" $resp]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonRequestBody
delete_CkHttpResponse $resp
delete_CkJsonObject $jsonResponse
delete_CkJsonObject $jsonPatch
delete_CkStringBuilder $sbHtml
exit
}
# A 200 response indicates success.
if {[CkHttpResponse_get_StatusCode $resp] == 200} then {
puts "Patched the reply draft."
set success 1
} else {
puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
puts "Failed to patch the reply draft."
set success 0
}
# Show the response in both cases..
CkJsonObject_Load $jsonResponse [CkHttpResponse_bodyStr $resp]
puts [CkJsonObject_emit $jsonResponse]
if {$success == 0} then {
delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonRequestBody
delete_CkHttpResponse $resp
delete_CkJsonObject $jsonResponse
delete_CkJsonObject $jsonPatch
delete_CkStringBuilder $sbHtml
exit
}
# ---------------------------------------------------------------------
# OK, let's send the reply email...
# To send, POST with an empty request body:
# POST https://graph.microsoft.com/v1.0/me/messages/{id}/send
set success [CkHttp_HttpStr $http "POST" "https://graph.microsoft.com/v1.0/me/messages/{$message_id}/send" "" "" "" $resp]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonRequestBody
delete_CkHttpResponse $resp
delete_CkJsonObject $jsonResponse
delete_CkJsonObject $jsonPatch
delete_CkStringBuilder $sbHtml
exit
}
# A 202 response indicates success.
if {[CkHttpResponse_get_StatusCode $resp] == 202} then {
puts "Sent the email reply."
# If the status code was 202, there is no response body.
} else {
puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
puts "Failed to send the email reply."
CkJsonObject_Load $jsonResponse [CkHttpResponse_bodyStr $resp]
puts [CkJsonObject_emit $jsonResponse]
}
puts "Finished."
# -----------------------------------------------------------------------
# A sample successful JSON response for the createReply looks like this:
# {
# "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#message",
# "@odata.type": "#microsoft.graph.message",
# "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADQAwR4\"",
# "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM-lQbAAAAA=",
# "createdDateTime": "2017-06-01T14:31:56Z",
# "lastModifiedDateTime": "2017-06-01T14:31:56Z",
# "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADQAwR4",
# "categories": [
# ],
# "receivedDateTime": "2017-06-01T14:31:56Z",
# "sentDateTime": "2017-06-01T14:31:56Z",
# "hasAttachments": false,
# "internetMessageId": "<SN1PR20MB0461AF40FC899A8462536F04E6F60@SN1PR20MB0461.namprd20.prod.outlook.com>",
# "subject": "RE: This email contains a PDF attachment",
# "bodyPreview": "________________________________\r\nFrom: Chilkat Software <support@chilkatsoft.com>\r\nSent: Tuesday, May 30, 2017 10:58:56 PM\r\nTo: chilkatsoft@outlook.com\r\nSubject: This email contains a PDF attachment\r\n\r\nThis email contains a PDF attachment\r\n--\r\nBest Regar",
# "importance": "normal",
# "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA",
# "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQAMMaWY-CWmVOqNKt-NiVhkU=",
# "isDeliveryReceiptRequested": false,
# "isReadReceiptRequested": false,
# "isRead": true,
# "isDraft": true,
# "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAgEPAAAA5%2BvF7TKKdE6bGCRqXyl2PQAAAM%2FlQbAAAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
# "inferenceClassification": "focused",
# "body": {
# "contentType": "html",
# "content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=us-ascii\">\r\n<meta content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body bgcolor=\"#FFFFFF\">\r\n<hr tabindex=\"-1\" style=\"display:inline-block; width:98%\"> ... </html>\r\n"
# },
# "sender": {
# "emailAddress": {
# "name": "Matt Smith",
# "address": "chilkatsoft@outlook.com"
# }
# },
# "from": {
# "emailAddress": {
# "name": "Matt Smith",
# "address": "chilkatsoft@outlook.com"
# }
# },
# "toRecipients": [
# {
# "emailAddress": {
# "name": "Chilkat Software",
# "address": "support@chilkatsoft.com"
# }
# }
# ],
# "ccRecipients": [
# ],
# "bccRecipients": [
# ],
# "replyTo": [
# ]
# }
#
# -----------------------------------------------------------------------
# A sample successful PATCH JSON response looks like this:
# {
# "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('admin%40chilkat.io')/messages/$entity",
# "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADQAwSA\"",
# "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM-lQbMAAAA=",
# "createdDateTime": "2017-06-01T15:18:14Z",
# "lastModifiedDateTime": "2017-06-01T15:18:17Z",
# "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADQAwSA",
# "categories": [
# ],
# "receivedDateTime": "2017-06-01T15:18:15Z",
# "sentDateTime": "2017-06-01T15:18:15Z",
# "hasAttachments": false,
# "internetMessageId": "<SN1PR20MB046138C4A26051200764FE38E6F60@SN1PR20MB0461.namprd20.prod.outlook.com>",
# "subject": "RE: This email has the word Amazon in the subject..",
# "bodyPreview": "This is my response.\r\n\r\n________________________________\r\nFrom: Chilkat Software <support@chilkatsoft.com>\r\nSent: Tuesday, May 30, 2017 11:40:01 PM\r\nTo: Chilkat Software\r\nSubject: This email has the word Amazon in the subject..\r\n\r\nThis email has the word ",
# "importance": "normal",
# "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA",
# "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQAE64PfPP1n1IhU4YasnNN0Q=",
# "isDeliveryReceiptRequested": false,
# "isReadReceiptRequested": false,
# "isRead": true,
# "isDraft": true,
# "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAgEPAAAA5%2BvF7TKKdE6bGCRqXyl2PQAAAM%2FlQbMAAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
# "inferenceClassification": "focused",
# "body": {
# "contentType": "html",
# "content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=us-ascii\">\r\n<meta content=\"text/html; charset=us-ascii\">\r\n<meta content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body bgcolor=\"#FFFFFF\">\r\n<p>This is my response.</p>\r\n<hr tabindex=\"-1\" style=\"display:inline-block; width:98%\">\r\n<div id=\"divRplyFwdMsg\" dir=\"ltr\"><font face=\"Calibri, sans-serif\" color=\"#000000\" style=\"font-size:11pt\"><b>From:</b> Chilkat Software <support@chilkatsoft.com><br>\r\n<b>Sent:</b> Tuesday, May 30, 2017 11:40:01 PM<br>\r\n<b>To:</b> Chilkat Software<br>\r\n<b>Subject:</b> This email has the word Amazon in the subject..</font>\r\n<div> </div>\r\n</div>\r\n<div><font face=\"Calibri\">This email has the word Amazon in the subject..</font><br>\r\n<div class=\"moz-signature\">-- <br>\r\nBest Regards,<br>\r\nMatt Smith<br>\r\nChilkat Software, Inc.<br>\r\n<p><a href=\"https://twitter.com/chilkatsoft\">Follow Chilkat on Twitter</a> </p>\r\n</div>\r\n</div>\r\n</body>\r\n</html>\r\n"
# },
# "sender": {
# "emailAddress": {
# "name": "Matt Smith",
# "address": "chilkatsoft@outlook.com"
# }
# },
# "from": {
# "emailAddress": {
# "name": "Matt Smith",
# "address": "chilkatsoft@outlook.com"
# }
# },
# "toRecipients": [
# {
# "emailAddress": {
# "name": "Chilkat Software",
# "address": "support@chilkatsoft.com"
# }
# }
# ],
# "ccRecipients": [
# ],
# "bccRecipients": [
# ],
# "replyTo": [
# ]
# }
delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonRequestBody
delete_CkHttpResponse $resp
delete_CkJsonObject $jsonResponse
delete_CkJsonObject $jsonPatch
delete_CkStringBuilder $sbHtml