Delphi DLL Requires Chilkat v11.0.0+
Delphi DLL
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 Delphi DLL Downloads
var
success: Boolean;
http: HCkHttp;
htFolderMap: HCkHashtable;
sbMap: HCkStringBuilder;
folderId: PWideChar;
json: HCkJsonObject;
sbResponse: HCkStringBuilder;
existingMsgId: PWideChar;
jsonRequestBody: HCkJsonObject;
resp: HCkHttpResponse;
jsonResponse: HCkJsonObject;
replyMsgId: PWideChar;
jsonPatch: HCkJsonObject;
sbHtml: HCkStringBuilder;
numReplaced: Integer;
numToRecipients: Integer;
i: Integer;
numCcRecipients: Integer;
begin
success := False;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Use your previously obtained access token here:
CkHttp_putAuthToken(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
htFolderMap := CkHashtable_Create();
sbMap := CkStringBuilder_Create();
CkStringBuilder_LoadFile(sbMap,'qa_data/outlook/folderMap.xml','utf-8');
CkHashtable_AddFromXmlSb(htFolderMap,sbMap);
// Get the ID for the "/Inbox" folder:
folderId := CkHashtable__lookupStr(htFolderMap,'/Inbox');
if (CkHashtable_getLastMethodSuccess(htFolderMap) <> True) then
begin
Memo1.Lines.Add('Folder ID not found');
Exit;
end;
success := True;
json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);
// 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'')');
sbResponse := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}',sbResponse);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
CkJsonObject_LoadSb(json,sbResponse);
// Show the results..
Memo1.Lines.Add(CkJsonObject__emit(json));
if (CkJsonObject_SizeOfArray(json,'value') = 0) then
begin
Memo1.Lines.Add('Empty result set.');
Exit;
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.
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"
// }
jsonRequestBody := CkJsonObject_Create();
CkJsonObject_UpdateString(jsonRequestBody,'comment','This is a comment');
CkHttp_SetUrlVar(http,'message_id',existingMsgId);
// Create the reply in the Drafts folder:
resp := CkHttpResponse_Create();
success := CkHttp_HttpJson(http,'POST','https://graph.microsoft.com/v1.0/me/messages/{$message_id}/createReply',jsonRequestBody,'application/json',resp);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
// A 201 response indicates success.
if (CkHttpResponse_getStatusCode(resp) = 201) then
begin
Memo1.Lines.Add('Created reply draft.');
success := True;
end
else
begin
Memo1.Lines.Add('Response status code = ' + IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add('Failed to create reply draft.');
success := False;
end;
// Show the response in both cases..
jsonResponse := CkJsonObject_Create();
CkJsonObject_putEmitCompact(jsonResponse,False);
CkJsonObject_Load(jsonResponse,CkHttpResponse__bodyStr(resp));
Memo1.Lines.Add(CkJsonObject__emit(jsonResponse));
if (success = False) then
begin
Exit;
end;
// ----------------------------------------------
// Get the message id of the newly created reply.
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"
// }
jsonPatch := CkJsonObject_Create();
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.
sbHtml := CkStringBuilder_Create();
CkJsonObject_StringOfSb(jsonResponse,'body.content',sbHtml);
// Insert the response HTML in the reply HTML body.
numReplaced := CkStringBuilder_ReplaceBetween(sbHtml,'<body bgcolor="#FFFFFF">','<hr ',#13#10,'<p>This is my response.</p>');
if (numReplaced <> 1) then
begin
Memo1.Lines.Add('Something is amiss!');
Exit;
end;
CkJsonObject_UpdateString(jsonPatch,'body.content',CkStringBuilder__getAsString(sbHtml));
// Add additional CC, BCC, or TO recipients like this:
numToRecipients := CkJsonObject_SizeOfArray(jsonResponse,'toRecipients');
i := 0;
// Copy existing TO recipients.
while i < numToRecipients do
begin
CkJsonObject_putI(jsonPatch,i);
CkJsonObject_putI(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'));
i := i + 1;
end;
// Add an additional TO recipient.
CkJsonObject_putI(jsonPatch,numToRecipients);
CkJsonObject_UpdateString(jsonPatch,'toRecipients[i].emailAddress.name','Chilkat');
CkJsonObject_UpdateString(jsonPatch,'toRecipients[i].emailAddress.address','admin@chilkat.io');
numCcRecipients := CkJsonObject_SizeOfArray(jsonResponse,'ccRecipients');
i := 0;
// Copy existing CC recipients.
while i < numCcRecipients do
begin
CkJsonObject_putI(jsonPatch,i);
CkJsonObject_putI(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'));
i := i + 1;
end;
// Add an additional CC recipient.
CkJsonObject_putI(jsonPatch,numCcRecipients);
CkJsonObject_UpdateString(jsonPatch,'ccRecipients[i].emailAddress.name','Chilkat GMail');
CkJsonObject_UpdateString(jsonPatch,'ccRecipients[i].emailAddress.address','chilkat.support@gmail.com');
CkJsonObject_putEmitCompact(jsonPatch,False);
Memo1.Lines.Add(CkJsonObject__emit(jsonPatch));
CkHttp_SetUrlVar(http,'message_id',replyMsgId);
success := CkHttp_HttpJson(http,'PATCH','https://graph.microsoft.com/v1.0/me/messages/{$message_id}',jsonPatch,'application/json',resp);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
// A 200 response indicates success.
if (CkHttpResponse_getStatusCode(resp) = 200) then
begin
Memo1.Lines.Add('Patched the reply draft.');
success := True;
end
else
begin
Memo1.Lines.Add('Response status code = ' + IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add('Failed to patch the reply draft.');
success := False;
end;
// Show the response in both cases..
CkJsonObject_Load(jsonResponse,CkHttpResponse__bodyStr(resp));
Memo1.Lines.Add(CkJsonObject__emit(jsonResponse));
if (success = False) then
begin
Exit;
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 := CkHttp_HttpStr(http,'POST','https://graph.microsoft.com/v1.0/me/messages/{$message_id}/send','','','',resp);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
// A 202 response indicates success.
if (CkHttpResponse_getStatusCode(resp) = 202) then
begin
Memo1.Lines.Add('Sent the email reply.');
// If the status code was 202, there is no response body.
end
else
begin
Memo1.Lines.Add('Response status code = ' + IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add('Failed to send the email reply.');
CkJsonObject_Load(jsonResponse,CkHttpResponse__bodyStr(resp));
Memo1.Lines.Add(CkJsonObject__emit(jsonResponse));
end;
Memo1.Lines.Add('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": [
// ]
// }
CkHttp_Dispose(http);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponse);
CkJsonObject_Dispose(jsonRequestBody);
CkHttpResponse_Dispose(resp);
CkJsonObject_Dispose(jsonResponse);
CkJsonObject_Dispose(jsonPatch);
CkStringBuilder_Dispose(sbHtml);