Xbase++ Requires Chilkat v11.0.0+
Xbase++
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 Xbase++ Downloads
LOCAL nSuccess
LOCAL oHttp
LOCAL oHtFolderMap
LOCAL oSbMap
LOCAL cFolderId
LOCAL oJson
LOCAL oSbResponse
LOCAL cExistingMsgId
LOCAL oJsonRequestBody
LOCAL oResp
LOCAL oJsonResponse
LOCAL cReplyMsgId
LOCAL oJsonPatch
LOCAL oSbHtml
LOCAL nNumReplaced
LOCAL nNumToRecipients
LOCAL i
LOCAL nNumCcRecipients
nSuccess := 0
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
oHttp := CreateObject("Chilkat.Http")
// Use your previously obtained access token here:
oHttp:AuthToken := "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
oHtFolderMap := CreateObject("Chilkat.Hashtable")
oSbMap := CreateObject("Chilkat.StringBuilder")
oSbMap:LoadFile("qa_data/outlook/folderMap.xml", "utf-8")
oHtFolderMap:AddFromXmlSb(oSbMap)
// Get the ID for the "/Inbox" folder:
cFolderId := oHtFolderMap:LookupStr("/Inbox")
IF (oHtFolderMap:LastMethodSuccess != 1)
? "Folder ID not found"
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
RETURN
ENDIF
nSuccess := 1
oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0
// Search for unread emails in this folder from support@chilkatsoft.com
oHttp:SetUrlVar("folder_id", cFolderId)
oHttp:SetUrlVar("select", "id,subject")
oHttp:SetUrlVar("filter", "(isRead eq false) and (from/emailAddress/address eq 'support@chilkatsoft.com')")
oSbResponse := CreateObject("Chilkat.StringBuilder")
nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", oSbResponse)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
RETURN
ENDIF
oJson:LoadSb(oSbResponse)
// Show the results..
? oJson:Emit()
IF (oJson:SizeOfArray("value") == 0)
? "Empty result set."
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
RETURN
ENDIF
// 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.
cExistingMsgId := oJson:StringOf("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"
// }
oJsonRequestBody := CreateObject("Chilkat.JsonObject")
oJsonRequestBody:UpdateString("comment", "This is a comment")
oHttp:SetUrlVar("message_id", cExistingMsgId)
// Create the reply in the Drafts folder:
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpJson("POST", "https://graph.microsoft.com/v1.0/me/messages/{$message_id}/createReply", oJsonRequestBody, "application/json", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
oJsonRequestBody:destroy()
oResp:destroy()
RETURN
ENDIF
// A 201 response indicates success.
IF (oResp:StatusCode == 201)
? "Created reply draft."
nSuccess := 1
ELSE
? "Response status code = " + Str(oResp:StatusCode)
? "Failed to create reply draft."
nSuccess := 0
ENDIF
// Show the response in both cases..
oJsonResponse := CreateObject("Chilkat.JsonObject")
oJsonResponse:EmitCompact := 0
oJsonResponse:Load(oResp:BodyStr)
? oJsonResponse:Emit()
IF (nSuccess == 0)
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
oJsonRequestBody:destroy()
oResp:destroy()
oJsonResponse:destroy()
RETURN
ENDIF
// ----------------------------------------------
// Get the message id of the newly created reply.
cReplyMsgId := oJsonResponse:StringOf("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"
// }
oJsonPatch := CreateObject("Chilkat.JsonObject")
oJsonPatch:UpdateString("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.
oSbHtml := CreateObject("Chilkat.StringBuilder")
oJsonResponse:StringOfSb("body.content", oSbHtml)
// Insert the response HTML in the reply HTML body.
nNumReplaced := oSbHtml:ReplaceBetween('<body bgcolor="#FFFFFF">', "<hr ", Chr(13) + Chr(10), "<p>This is my response.</p>")
IF (nNumReplaced != 1)
? "Something is amiss!"
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
oJsonRequestBody:destroy()
oResp:destroy()
oJsonResponse:destroy()
oJsonPatch:destroy()
oSbHtml:destroy()
RETURN
ENDIF
oJsonPatch:UpdateString("body.content", oSbHtml:GetAsString())
// Add additional CC, BCC, or TO recipients like this:
nNumToRecipients := oJsonResponse:SizeOfArray("toRecipients")
i := 0
// Copy existing TO recipients.
DO WHILE i < nNumToRecipients
oJsonPatch:I := i
oJsonResponse:I := i
oJsonPatch:UpdateString("toRecipients[i].emailAddress.name", oJsonResponse:StringOf("toRecipients[i].emailAddress.name"))
oJsonPatch:UpdateString("toRecipients[i].emailAddress.address", oJsonResponse:StringOf("toRecipients[i].emailAddress.address"))
i := i + 1
ENDDO
// Add an additional TO recipient.
oJsonPatch:I := nNumToRecipients
oJsonPatch:UpdateString("toRecipients[i].emailAddress.name", "Chilkat")
oJsonPatch:UpdateString("toRecipients[i].emailAddress.address", "admin@chilkat.io")
nNumCcRecipients := oJsonResponse:SizeOfArray("ccRecipients")
i := 0
// Copy existing CC recipients.
DO WHILE i < nNumCcRecipients
oJsonPatch:I := i
oJsonResponse:I := i
oJsonPatch:UpdateString("ccRecipients[i].emailAddress.name", oJsonResponse:StringOf("ccRecipients[i].emailAddress.name"))
oJsonPatch:UpdateString("ccRecipients[i].emailAddress.address", oJsonResponse:StringOf("ccRecipients[i].emailAddress.address"))
i := i + 1
ENDDO
// Add an additional CC recipient.
oJsonPatch:I := nNumCcRecipients
oJsonPatch:UpdateString("ccRecipients[i].emailAddress.name", "Chilkat GMail")
oJsonPatch:UpdateString("ccRecipients[i].emailAddress.address", "chilkat.support@gmail.com")
oJsonPatch:EmitCompact := 0
? oJsonPatch:Emit()
oHttp:SetUrlVar("message_id", cReplyMsgId)
nSuccess := oHttp:HttpJson("PATCH", "https://graph.microsoft.com/v1.0/me/messages/{$message_id}", oJsonPatch, "application/json", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
oJsonRequestBody:destroy()
oResp:destroy()
oJsonResponse:destroy()
oJsonPatch:destroy()
oSbHtml:destroy()
RETURN
ENDIF
// A 200 response indicates success.
IF (oResp:StatusCode == 200)
? "Patched the reply draft."
nSuccess := 1
ELSE
? "Response status code = " + Str(oResp:StatusCode)
? "Failed to patch the reply draft."
nSuccess := 0
ENDIF
// Show the response in both cases..
oJsonResponse:Load(oResp:BodyStr)
? oJsonResponse:Emit()
IF (nSuccess == 0)
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
oJsonRequestBody:destroy()
oResp:destroy()
oJsonResponse:destroy()
oJsonPatch:destroy()
oSbHtml:destroy()
RETURN
ENDIF
// ---------------------------------------------------------------------
// 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
nSuccess := oHttp:HttpStr("POST", "https://graph.microsoft.com/v1.0/me/messages/{$message_id}/send", "", "", "", oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
oJsonRequestBody:destroy()
oResp:destroy()
oJsonResponse:destroy()
oJsonPatch:destroy()
oSbHtml:destroy()
RETURN
ENDIF
// A 202 response indicates success.
IF (oResp:StatusCode == 202)
? "Sent the email reply."
// If the status code was 202, there is no response body.
ELSE
? "Response status code = " + Str(oResp:StatusCode)
? "Failed to send the email reply."
oJsonResponse:Load(oResp:BodyStr)
? oJsonResponse:Emit()
ENDIF
? "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": [
// ]
// }
oHttp:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbResponse:destroy()
oJsonRequestBody:destroy()
oResp:destroy()
oJsonResponse:destroy()
oJsonPatch:destroy()
oSbHtml:destroy()