(Excel) Outlook -- Create Reply Email, Update, and Send

Creates a reply email in the Drafts folder, updates the reply with information, and then sends the reply.

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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' Use your previously obtained access token here:
http.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 
Dim htFolderMap As Chilkat.Hashtable
Set htFolderMap = Chilkat.NewHashtable
Dim sbMap As Chilkat.StringBuilder
Set sbMap = Chilkat.NewStringBuilder
Dim success As Boolean
success = sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
success = htFolderMap.AddFromXmlSb(sbMap)

' Get the ID for the "/Inbox" folder:

folderId = htFolderMap.LookupStr("/Inbox")
If (htFolderMap.LastMethodSuccess <> True) Then
    Debug.Print "Folder ID not found"
    Exit Sub
End If


success = True
Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False

' Search for unread emails in this folder from support@chilkatsoft.com 
success = http.SetUrlVar("folder_id",folderId)
success = http.SetUrlVar("select","id,subject")
success = http.SetUrlVar("filter","(isRead eq false) and (from/emailAddress/address eq 'support@chilkatsoft.com')")

Dim sbResponse As Chilkat.StringBuilder
Set sbResponse = Chilkat.NewStringBuilder
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
If (success <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

success = json.LoadSb(sbResponse)
' Show the results..
Debug.Print json.Emit()

If (json.SizeOfArray("value") = 0) Then
    Debug.Print "Empty result set."
    Exit Sub
End If

' 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.


existingMsgId = json.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"
' 	}

Dim jsonRequestBody As Chilkat.JsonObject
Set jsonRequestBody = Chilkat.NewJsonObject
success = jsonRequestBody.UpdateString("comment","This is a comment")

success = http.SetUrlVar("message_id",existingMsgId)

' Create the reply in the Drafts folder:

Set resp = http.PostJson2("https://graph.microsoft.com/v1.0/me/messages/{$message_id}/createReply","application/json",jsonRequestBody.Emit())
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' A 201 response indicates success.
If (resp.StatusCode = 201) Then
    Debug.Print "Created reply draft."
    success = True
Else
    Debug.Print "Response status code = "; resp.StatusCode
    Debug.Print "Failed to create reply draft."
    success = False
End If

' Show the response in both cases..
Dim jsonResponse As Chilkat.JsonObject
Set jsonResponse = Chilkat.NewJsonObject
jsonResponse.EmitCompact = False
success = jsonResponse.Load(resp.BodyStr)
Debug.Print jsonResponse.Emit()

If (success = False) Then
    Exit Sub
End If

' ----------------------------------------------
' Get the message id of the newly created reply.

replyMsgId = jsonResponse.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"
' 	}

Dim jsonPatch As Chilkat.JsonObject
Set jsonPatch = Chilkat.NewJsonObject
success = jsonPatch.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.
Dim sbHtml As Chilkat.StringBuilder
Set sbHtml = Chilkat.NewStringBuilder
success = jsonResponse.StringOfSb("body.content",sbHtml)
' Insert the response HTML in the reply HTML body.

numReplaced = sbHtml.ReplaceBetween("<body bgcolor=""#FFFFFF"">","<hr ",vbCrLf,"<p>This is my response.</p>")
If (numReplaced <> 1) Then
    Debug.Print "Something is amiss!"
    Exit Sub
End If

success = jsonPatch.UpdateString("body.content",sbHtml.GetAsString())

' Add additional CC, BCC, or TO recipients like this:

numToRecipients = jsonResponse.SizeOfArray("toRecipients")

i = 0
' Copy existing TO recipients.
Do While i < numToRecipients
    jsonPatch.I = i
    jsonResponse.I = i
    success = jsonPatch.UpdateString("toRecipients[i].emailAddress.name",jsonResponse.StringOf("toRecipients[i].emailAddress.name"))
    success = jsonPatch.UpdateString("toRecipients[i].emailAddress.address",jsonResponse.StringOf("toRecipients[i].emailAddress.address"))
    i = i + 1
Loop
' Add an additional TO recipient.
jsonPatch.I = numToRecipients
success = jsonPatch.UpdateString("toRecipients[i].emailAddress.name","Chilkat")
success = jsonPatch.UpdateString("toRecipients[i].emailAddress.address","admin@chilkat.io")


numCcRecipients = jsonResponse.SizeOfArray("ccRecipients")
i = 0
' Copy existing CC recipients.
Do While i < numCcRecipients
    jsonPatch.I = i
    jsonResponse.I = i
    success = jsonPatch.UpdateString("ccRecipients[i].emailAddress.name",jsonResponse.StringOf("ccRecipients[i].emailAddress.name"))
    success = jsonPatch.UpdateString("ccRecipients[i].emailAddress.address",jsonResponse.StringOf("ccRecipients[i].emailAddress.address"))
    i = i + 1
Loop
' Add an additional CC recipient.
jsonPatch.I = numCcRecipients
success = jsonPatch.UpdateString("ccRecipients[i].emailAddress.name","Chilkat GMail")
success = jsonPatch.UpdateString("ccRecipients[i].emailAddress.address","chilkat.support@gmail.com")

jsonPatch.EmitCompact = False
Debug.Print jsonPatch.Emit()

success = http.SetUrlVar("message_id",replyMsgId)
Set resp = http.PText("PATCH","https://graph.microsoft.com/v1.0/me/messages/{$message_id}",jsonPatch.Emit(),"utf-8","application/json",False,False)
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' A 200 response indicates success.
If (resp.StatusCode = 200) Then
    Debug.Print "Patched the reply draft."
    success = True
Else
    Debug.Print "Response status code = "; resp.StatusCode
    Debug.Print "Failed to patch the reply draft."
    success = False
End If

' Show the response in both cases..
success = jsonResponse.Load(resp.BodyStr)
Debug.Print jsonResponse.Emit()

If (success = False) Then
    Exit Sub
End If

' ---------------------------------------------------------------------
' 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 resp = http.PText("POST","https://graph.microsoft.com/v1.0/me/messages/{$message_id}/send","","","",False,False)
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' A 202 response indicates success.
If (resp.StatusCode = 202) Then
    Debug.Print "Sent the email reply."
    ' If the status code was 202, there is no response body.
Else
    Debug.Print "Response status code = "; resp.StatusCode
    Debug.Print "Failed to send the email reply."
    success = jsonResponse.Load(resp.BodyStr)
    Debug.Print jsonResponse.Emit()
End If

Debug.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 &lt;support@chilkatsoft.com&gt;<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>&nbsp;</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": [
' 	  ]
' 	}