Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Ruby Examples

ASN.1
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
Facebook
FileAccess
Firebase
GMail REST API
GeoOp
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Sheets
Gzip
HTML-to-XML/Text
HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)

Java KeyStore (JKS)
Jira
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
PayPal
Peoplevox
QuickBooks
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Shopify
Socket/SSL/TLS
Spider
Stream
Stripe
SugarCRM
Tar Archive
Twitter
Upload
VoiceBase
Walmart
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Xero
Zip
curl
eBay

 

 

 

(Ruby) 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 Ruby Downloads

Ruby Library for Linux and MAC OS X

require 'chilkat'

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

http = Chilkat::CkHttp.new()

#  Use your previously obtained access token here:
http.put_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
htFolderMap = Chilkat::CkHashtable.new()
sbMap = Chilkat::CkStringBuilder.new()
sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
htFolderMap.AddFromXmlSb(sbMap)

#  Get the ID for the "/Inbox" folder:
folderId = htFolderMap.lookupStr("/Inbox")
if (htFolderMap.get_LastMethodSuccess() != true)
    print "Folder ID not found" + "\n";
    exit
end

success = true
json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)

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

sbResponse = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/users/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if (success != true)
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
# Show the results..
print json.emit() + "\n";

if (json.SizeOfArray("value") == 0)
    print "Empty result set." + "\n";
    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 = 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"
#  	}

jsonRequestBody = Chilkat::CkJsonObject.new()
jsonRequestBody.UpdateString("comment","This is a comment")

http.SetUrlVar("message_id",existingMsgId)

#  Create the reply in the Drafts folder:
# resp is a CkHttpResponse
resp = http.PostJson2("https://graph.microsoft.com/v1.0/users/me/messages/{$message_id}/createReply","application/json",jsonRequestBody.emit())
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

#  A 201 response indicates success.
if (resp.get_StatusCode() == 201)
    print "Created reply draft." + "\n";
    success = true
else
    print "Response status code = " + resp.get_StatusCode().to_s() + "\n";
    print "Failed to create reply draft." + "\n";
    success = false
end

#  Show the response in both cases..
jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.put_EmitCompact(false)
jsonResponse.Load(resp.bodyStr())
print jsonResponse.emit() + "\n";

if (success == false)
    exit
end

#  ----------------------------------------------
#  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"
#  	}

jsonPatch = Chilkat::CkJsonObject.new()
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.
sbHtml = Chilkat::CkStringBuilder.new()
jsonResponse.StringOfSb("body.content",sbHtml)
#  Insert the response HTML in the reply HTML body.
numReplaced = sbHtml.ReplaceBetween("<body bgcolor=\"#FFFFFF\">","<hr ","\r\n","<p>This is my response.</p>")
if (numReplaced != 1)
    print "Something is amiss!" + "\n";
    exit
end

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.
while i < numToRecipients
    jsonPatch.put_I(i)
    jsonResponse.put_I(i)
    jsonPatch.UpdateString("toRecipients[i].emailAddress.name",jsonResponse.stringOf("toRecipients[i].emailAddress.name"))
    jsonPatch.UpdateString("toRecipients[i].emailAddress.address",jsonResponse.stringOf("toRecipients[i].emailAddress.address"))
    i = i + 1
end
#  Add an additional TO recipient.
jsonPatch.put_I(numToRecipients)
jsonPatch.UpdateString("toRecipients[i].emailAddress.name","Chilkat")
jsonPatch.UpdateString("toRecipients[i].emailAddress.address","admin@chilkat.io")

numCcRecipients = jsonResponse.SizeOfArray("ccRecipients")
i = 0
#  Copy existing CC recipients.
while i < numCcRecipients
    jsonPatch.put_I(i)
    jsonResponse.put_I(i)
    jsonPatch.UpdateString("ccRecipients[i].emailAddress.name",jsonResponse.stringOf("ccRecipients[i].emailAddress.name"))
    jsonPatch.UpdateString("ccRecipients[i].emailAddress.address",jsonResponse.stringOf("ccRecipients[i].emailAddress.address"))
    i = i + 1
end
#  Add an additional CC recipient.
jsonPatch.put_I(numCcRecipients)
jsonPatch.UpdateString("ccRecipients[i].emailAddress.name","Chilkat GMail")
jsonPatch.UpdateString("ccRecipients[i].emailAddress.address","chilkat.support@gmail.com")

jsonPatch.put_EmitCompact(false)
print jsonPatch.emit() + "\n";

http.SetUrlVar("message_id",replyMsgId)
# resp is a CkHttpResponse
resp = http.PText("PATCH","https://graph.microsoft.com/v1.0/me/messages/{$message_id}",jsonPatch.emit(),"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

#  A 200 response indicates success.
if (resp.get_StatusCode() == 200)
    print "Patched the reply draft." + "\n";
    success = true
else
    print "Response status code = " + resp.get_StatusCode().to_s() + "\n";
    print "Failed to patch the reply draft." + "\n";
    success = false
end

#  Show the response in both cases..
jsonResponse.Load(resp.bodyStr())
print jsonResponse.emit() + "\n";

if (success == false)
    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

# resp is a CkHttpResponse
resp = http.PText("POST","https://graph.microsoft.com/v1.0/me/messages/{$message_id}/send","","","",false,false)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

#  A 202 response indicates success.
if (resp.get_StatusCode() == 202)
    print "Sent the email reply." + "\n";
    #  If the status code was 202, there is no response body.
else
    print "Response status code = " + resp.get_StatusCode().to_s() + "\n";
    print "Failed to send the email reply." + "\n";
    jsonResponse.Load(resp.bodyStr())
    print jsonResponse.emit() + "\n";
end

print "Finished." + "\n";

#  -----------------------------------------------------------------------
#  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 Murdock",
#  	      "address": "chilkatsoft@outlook.com"
#  	    }
#  	  },
#  	  "from": {
#  	    "emailAddress": {
#  	      "name": "Matt Murdock",
#  	      "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 Murdock<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 Murdock",
#  	      "address": "chilkatsoft@outlook.com"
#  	    }
#  	  },
#  	  "from": {
#  	    "emailAddress": {
#  	      "name": "Matt Murdock",
#  	      "address": "chilkatsoft@outlook.com"
#  	    }
#  	  },
#  	  "toRecipients": [
#  	    {
#  	      "emailAddress": {
#  	        "name": "Chilkat Software",
#  	        "address": "support@chilkatsoft.com"
#  	      }
#  	    }
#  	  ],
#  	  "ccRecipients": [
#  	  ],
#  	  "bccRecipients": [
#  	  ],
#  	  "replyTo": [
#  	  ]
#  	}

 

© 2000-2016 Chilkat Software, Inc. All Rights Reserved.