(Objective-C) 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

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoHashtable.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];

// 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 
CkoHashtable *htFolderMap = [[CkoHashtable alloc] init];
CkoStringBuilder *sbMap = [[CkoStringBuilder alloc] init];
[sbMap LoadFile: @"qa_data/outlook/folderMap.xml" charset: @"utf-8"];
[htFolderMap AddFromXmlSb: sbMap];

// Get the ID for the "/Inbox" folder:
NSString *folderId = [htFolderMap LookupStr: @"/Inbox"];
if (htFolderMap.LastMethodSuccess != YES) {
    NSLog(@"%@",@"Folder ID not found");
    return;
}

BOOL success = YES;
CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;

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

CkoStringBuilder *sbResponse = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}" sbContent: sbResponse];
if (success != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
// Show the results..
NSLog(@"%@",[json Emit]);

if ([[json SizeOfArray: @"value"] intValue] == 0) {
    NSLog(@"%@",@"Empty result set.");
    return;
}

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

NSString *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"
// 	}

CkoJsonObject *jsonRequestBody = [[CkoJsonObject alloc] init];
[jsonRequestBody UpdateString: @"comment" value: @"This is a comment"];

[http SetUrlVar: @"message_id" value: existingMsgId];

// Create the reply in the Drafts folder:
CkoHttpResponse *resp = [http PostJson2: @"https://graph.microsoft.com/v1.0/me/messages/{$message_id}/createReply" contentType: @"application/json" jsonText: [jsonRequestBody Emit]];
if (http.LastMethodSuccess != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

// A 201 response indicates success.
if ([resp.StatusCode intValue] == 201) {
    NSLog(@"%@",@"Created reply draft.");
    success = YES;
}
else {
    NSLog(@"%@%d",@"Response status code = ",[resp.StatusCode intValue]);
    NSLog(@"%@",@"Failed to create reply draft.");
    success = NO;
}

// Show the response in both cases..
CkoJsonObject *jsonResponse = [[CkoJsonObject alloc] init];
jsonResponse.EmitCompact = NO;
[jsonResponse Load: resp.BodyStr];
NSLog(@"%@",[jsonResponse Emit]);

if (success == NO) {
    return;
}

// ----------------------------------------------
// Get the message id of the newly created reply.
NSString *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"
// 	}

CkoJsonObject *jsonPatch = [[CkoJsonObject alloc] init];
[jsonPatch UpdateString: @"body.contentType" value: @"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.
CkoStringBuilder *sbHtml = [[CkoStringBuilder alloc] init];
[jsonResponse StringOfSb: @"body.content" sb: sbHtml];
// Insert the response HTML in the reply HTML body.
int numReplaced = [[sbHtml ReplaceBetween: @"<body bgcolor=\"#FFFFFF\">" endMark: @"<hr " value: @"\r\n" replacement: @"<p>This is my response.</p>"] intValue];
if (numReplaced != 1) {
    NSLog(@"%@",@"Something is amiss!");
    return;
}

[jsonPatch UpdateString: @"body.content" value: [sbHtml GetAsString]];

// Add additional CC, BCC, or TO recipients like this:
int numToRecipients = [[jsonResponse SizeOfArray: @"toRecipients"] intValue];
int i = 0;
// Copy existing TO recipients.
while (i < numToRecipients) {
    jsonPatch.I = [NSNumber numberWithInt: i];
    jsonResponse.I = [NSNumber numberWithInt: i];
    [jsonPatch UpdateString: @"toRecipients[i].emailAddress.name" value: [jsonResponse StringOf: @"toRecipients[i].emailAddress.name"]];
    [jsonPatch UpdateString: @"toRecipients[i].emailAddress.address" value: [jsonResponse StringOf: @"toRecipients[i].emailAddress.address"]];
    i = i + 1;
}

// Add an additional TO recipient.
jsonPatch.I = [NSNumber numberWithInt: numToRecipients];
[jsonPatch UpdateString: @"toRecipients[i].emailAddress.name" value: @"Chilkat"];
[jsonPatch UpdateString: @"toRecipients[i].emailAddress.address" value: @"admin@chilkat.io"];

int numCcRecipients = [[jsonResponse SizeOfArray: @"ccRecipients"] intValue];
i = 0;
// Copy existing CC recipients.
while (i < numCcRecipients) {
    jsonPatch.I = [NSNumber numberWithInt: i];
    jsonResponse.I = [NSNumber numberWithInt: i];
    [jsonPatch UpdateString: @"ccRecipients[i].emailAddress.name" value: [jsonResponse StringOf: @"ccRecipients[i].emailAddress.name"]];
    [jsonPatch UpdateString: @"ccRecipients[i].emailAddress.address" value: [jsonResponse StringOf: @"ccRecipients[i].emailAddress.address"]];
    i = i + 1;
}

// Add an additional CC recipient.
jsonPatch.I = [NSNumber numberWithInt: numCcRecipients];
[jsonPatch UpdateString: @"ccRecipients[i].emailAddress.name" value: @"Chilkat GMail"];
[jsonPatch UpdateString: @"ccRecipients[i].emailAddress.address" value: @"chilkat.support@gmail.com"];

jsonPatch.EmitCompact = NO;
NSLog(@"%@",[jsonPatch Emit]);

[http SetUrlVar: @"message_id" value: replyMsgId];
resp = [http PText: @"PATCH" url: @"https://graph.microsoft.com/v1.0/me/messages/{$message_id}" textData: [jsonPatch Emit] charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

// A 200 response indicates success.
if ([resp.StatusCode intValue] == 200) {
    NSLog(@"%@",@"Patched the reply draft.");
    success = YES;
}
else {
    NSLog(@"%@%d",@"Response status code = ",[resp.StatusCode intValue]);
    NSLog(@"%@",@"Failed to patch the reply draft.");
    success = NO;
}

// Show the response in both cases..
[jsonResponse Load: resp.BodyStr];
NSLog(@"%@",[jsonResponse Emit]);

if (success == NO) {
    return;
}

// ---------------------------------------------------------------------
// 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

resp = [http PText: @"POST" url: @"https://graph.microsoft.com/v1.0/me/messages/{$message_id}/send" textData: @"" charset: @"" contentType: @"" md5: NO gzip: NO];
if (http.LastMethodSuccess != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

// A 202 response indicates success.
if ([resp.StatusCode intValue] == 202) {
    NSLog(@"%@",@"Sent the email reply.");
    // If the status code was 202, there is no response body.
}
else {
    NSLog(@"%@%d",@"Response status code = ",[resp.StatusCode intValue]);
    NSLog(@"%@",@"Failed to send the email reply.");
    [jsonResponse Load: resp.BodyStr];
    NSLog(@"%@",[jsonResponse Emit]);
}

NSLog(@"%@",@"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": [
// 	  ]
// 	}