Lua Requires Chilkat v11.0.0+
Lua
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 Lua Downloads
local chilkat = require("chilkat")
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
local http = chilkat.Http.new()
-- Use your previously obtained access token here:
http.auth_token = "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
local htFolderMap = chilkat.Hashtable.new()
local sbMap = chilkat.StringBuilder.new()
sbMap:load_file("qa_data/outlook/folderMap.xml", "utf-8")
htFolderMap:add_from_xml_sb(sbMap)
-- Get the ID for the "/Inbox" folder:
local folderId = htFolderMap:lookup_str("/Inbox")
if not htFolderMap.last_method_success then
print("Folder ID not found")
return
end
local success = true
local json = chilkat.JsonObject.new()
json.emit_compact = false
-- Search for unread emails in this folder from support@chilkatsoft.com
http:set_url_var("folder_id", folderId)
http:set_url_var("select", "id,subject")
http:set_url_var("filter", "(isRead eq false) and (from/emailAddress/address eq 'support@chilkatsoft.com')")
local sbResponse = chilkat.StringBuilder.new()
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse)
if not success then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
-- Show the results..
print(json:emit())
if json:size_of_array("value") == 0 then
print("Empty result set.")
return
end
-- 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.
local existingMsgId = json:string_of("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"
-- }
local jsonRequestBody = chilkat.JsonObject.new()
jsonRequestBody:update_string("comment", "This is a comment")
http:set_url_var("message_id", existingMsgId)
-- Create the reply in the Drafts folder:
local resp = chilkat.HttpResponse.new()
success = http:http_json("POST", "https://graph.microsoft.com/v1.0/me/messages/{$message_id}/createReply", jsonRequestBody, "application/json", resp)
if not success then
print(http.last_error_text)
return
end
-- A 201 response indicates success.
if resp.status_code == 201 then
print("Created reply draft.")
success = true
else
print("Response status code = " .. resp.status_code)
print("Failed to create reply draft.")
success = false
end
-- Show the response in both cases..
local jsonResponse = chilkat.JsonObject.new()
jsonResponse.emit_compact = false
jsonResponse:load(resp.body_str)
print(jsonResponse:emit())
if not success then
return
end
-- ----------------------------------------------
-- Get the message id of the newly created reply.
local replyMsgId = jsonResponse:string_of("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"
-- }
local jsonPatch = chilkat.JsonObject.new()
jsonPatch:update_string("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.
local sbHtml = chilkat.StringBuilder.new()
jsonResponse:string_of_sb("body.content", sbHtml)
-- Insert the response HTML in the reply HTML body.
local numReplaced = sbHtml:replace_between("<body bgcolor=\"#FFFFFF\">", "<hr ", "\r\n", "<p>This is my response.</p>")
if numReplaced ~= 1 then
print("Something is amiss!")
return
end
jsonPatch:update_string("body.content", sbHtml:get_as_string())
-- Add additional CC, BCC, or TO recipients like this:
local numToRecipients = jsonResponse:size_of_array("toRecipients")
local i = 0
-- Copy existing TO recipients.
while i < numToRecipients do
jsonPatch.i = i
jsonResponse.i = i
jsonPatch:update_string("toRecipients[i].emailAddress.name", jsonResponse:string_of("toRecipients[i].emailAddress.name"))
jsonPatch:update_string("toRecipients[i].emailAddress.address", jsonResponse:string_of("toRecipients[i].emailAddress.address"))
i = i + 1
end
-- Add an additional TO recipient.
jsonPatch.i = numToRecipients
jsonPatch:update_string("toRecipients[i].emailAddress.name", "Chilkat")
jsonPatch:update_string("toRecipients[i].emailAddress.address", "admin@chilkat.io")
local numCcRecipients = jsonResponse:size_of_array("ccRecipients")
i = 0
-- Copy existing CC recipients.
while i < numCcRecipients do
jsonPatch.i = i
jsonResponse.i = i
jsonPatch:update_string("ccRecipients[i].emailAddress.name", jsonResponse:string_of("ccRecipients[i].emailAddress.name"))
jsonPatch:update_string("ccRecipients[i].emailAddress.address", jsonResponse:string_of("ccRecipients[i].emailAddress.address"))
i = i + 1
end
-- Add an additional CC recipient.
jsonPatch.i = numCcRecipients
jsonPatch:update_string("ccRecipients[i].emailAddress.name", "Chilkat GMail")
jsonPatch:update_string("ccRecipients[i].emailAddress.address", "chilkat.support@gmail.com")
jsonPatch.emit_compact = false
print(jsonPatch:emit())
http:set_url_var("message_id", replyMsgId)
success = http:http_json("PATCH", "https://graph.microsoft.com/v1.0/me/messages/{$message_id}", jsonPatch, "application/json", resp)
if not success then
print(http.last_error_text)
return
end
-- A 200 response indicates success.
if resp.status_code == 200 then
print("Patched the reply draft.")
success = true
else
print("Response status code = " .. resp.status_code)
print("Failed to patch the reply draft.")
success = false
end
-- Show the response in both cases..
jsonResponse:load(resp.body_str)
print(jsonResponse:emit())
if not success then
return
end
-- ---------------------------------------------------------------------
-- 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
success = http:http_str("POST", "https://graph.microsoft.com/v1.0/me/messages/{$message_id}/send", "", "", "", resp)
if not success then
print(http.last_error_text)
return
end
-- A 202 response indicates success.
if resp.status_code == 202 then
print("Sent the email reply.")
-- If the status code was 202, there is no response body.
else
print("Response status code = " .. resp.status_code)
print("Failed to send the email reply.")
jsonResponse:load(resp.body_str)
print(jsonResponse:emit())
end
print("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": [
-- ]
-- }