(Ruby) Outlook Send HTML Email with Embedded Images

This example sends an HTML email with embedded images. Other examples exist for:

Sending plain-text email.
Sending email with attachments.
Sending HTML email with embedded images and attachments.

Chilkat Ruby Downloads

install from rubygems.org
gem install chilkat
or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# Important: This example requires Chilkat v9.5.0.68 or greater.

# 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:
# See the following examples for getting an access token:
#    Get Microsoft Graph OAuth2 Access Token (Azure AD v2.0 Endpoint).
#    Get Microsoft Graph OAuth2 Access Token (Azure AD Endpoint).
#    Refresh Access Token (Azure AD v2.0 Endpoint).
#    Refresh Access Token (Azure AD Endpoint).

http.put_AuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN")

# To send mail, we'll POST to the following endpoint:
# 
# POST /users/{id | userPrincipalName}/sendMail
# 
# (The special keyword "me" may be used in place of a principal name.)
# 

# This example will send HTML email containing the following HTML body.
# After the 

# 	<html>
# 	<head>
# 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
# 	<meta content="text/html; charset=utf-8">
# 	</head>
# 	<body bgcolor="#FFFFFF">
# 	<font face="Calibri">This is a test <b>HTML email with embedded images</b>.<br>
# 	<br>
# 	<img alt="" src="cid:starfish"><br>
# 	<img alt="" src="cid:hedgehogs"><br>
# 	</font>
# 	</body>
# 	</html>

# Build the HTML body...
bCrlf = true
sbHtmlBody = Chilkat::CkStringBuilder.new()
sbHtmlBody.AppendLine("<html>",bCrlf)
sbHtmlBody.AppendLine("<head>",bCrlf)
sbHtmlBody.AppendLine("<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">",bCrlf)
sbHtmlBody.AppendLine("<meta content=\"text/html; charset=utf-8\">",bCrlf)
sbHtmlBody.AppendLine("</head>",bCrlf)
sbHtmlBody.AppendLine("<body bgcolor=\"#FFFFFF\">",bCrlf)
sbHtmlBody.AppendLine("<font face=\"Calibri\">This is a test <b>HTML email with embedded images</b>.<br>",bCrlf)
sbHtmlBody.AppendLine("<br>",bCrlf)
sbHtmlBody.AppendLine("<img alt=\"\" src=\"cid:starfish\"><br>",bCrlf)
sbHtmlBody.AppendLine("<img alt=\"\" src=\"cid:hedgehogs\"><br>",bCrlf)
sbHtmlBody.AppendLine("</font>",bCrlf)
sbHtmlBody.AppendLine("</body>",bCrlf)
sbHtmlBody.AppendLine("</html>",bCrlf)

# Load the image files.
jpgStarfish = Chilkat::CkBinData.new()
jpgStarfish.LoadFile("qa_data/jpg/starfish.jpg")
jpgHedgeHogs = Chilkat::CkBinData.new()
jpgHedgeHogs.LoadFile("qa_data/jpg/hedgehogs.jpg")

# The body of the POST request contains JSON that specifies the email subject, body,
# recipients, etc.  This example will build the following JSON HTML email:
# 

# 	{
# 	  "message": {
# 	    "subject": "Sample HTML Email with Embedded Images",
# 	    "body": {
# 	      "contentType": "html",
# 	      "content": "The HTML body goes here..."
# 	    },
# 	    "toRecipients": [
# 	      {
# 	        "emailAddress": {
# 		  "name": "Chilkat Software",
# 	          "address": "admin@chilkat.io"
# 	        }
# 	      },
# 	      {
# 	        "emailAddress": {
# 	          "address": "chilkat.support@gmail.com"
# 	        }
# 	      }
# 	    ],
# 	    "ccRecipients": [
# 	      {
# 	        "emailAddress": {
# 		  "name": "Chilkat Blog",
# 		  "address": "admin@cknotes.com"
# 	        }
# 	      }
# 	    ],
# 	    "attachments": [
# 	       {
# 	         "@odata.type": "#microsoft.graph.fileAttachment",
# 	         "name": "starfish.jpg",
# 	         "contentType": "image/jpeg",
# 	         "size": 6497,
# 	         "isInline": true,
# 	         "contentId": "starfish",
# 	         "contentLocation": null,
# 	         "contentBytes": "base64_data_here"
# 	       },
# 	       {
# 	         "@odata.type": "#microsoft.graph.fileAttachment",
# 	         "name": "hedgehogs.jpg",
# 	         "contentType": "image/jpeg",
# 	         "size": 48845,
# 	         "isInline": true,
# 	         "contentId": "hedgehogs",
# 	         "contentLocation": null,
# 	         "contentBytes": "base64_data_here"
# 	       }
# 	    ]
# 	  },
# 	  "saveToSentItems": true
# 	}
# 
# Build the above JSON.
json = Chilkat::CkJsonObject.new()
json.UpdateString("message.subject","Sample HTML Email with Embedded Images")
json.UpdateString("message.body.contentType","html")
json.UpdateString("message.body.content",sbHtmlBody.getAsString())

json.UpdateString("message.toRecipients[0].emailAddress.name","Chilkat Software")
json.UpdateString("message.toRecipients[0].emailAddress.address","admin@chilkat.io")
json.UpdateString("message.toRecipients[1].emailAddress.address","chilkat.support@gmail.com")
json.UpdateString("message.ccRecipients[0].emailAddress.name","Chilkat Blog")
json.UpdateString("message.ccRecipients[0].emailAddress.address","admin@cknotes.com")

json.UpdateString("message.attachments[0].\"@odata.type\"","#microsoft.graph.fileAttachment")
json.UpdateString("message.attachments[0].name","starfish.jpg")
json.UpdateString("message.attachments[0].contentType","image/jpeg")
json.UpdateInt("message.attachments[0].size",jpgStarfish.get_NumBytes())
json.UpdateBool("message.attachments[0].isInline",true)
# This contentId must match the "cid:" in the HTML
json.UpdateString("message.attachments[0].contentId","starfish")
json.UpdateNull("message.attachments[0].contentLocation")
json.UpdateBd("message.attachments[0].contentBytes","base64",jpgStarfish)

json.UpdateString("message.attachments[1].\"@odata.type\"","#microsoft.graph.fileAttachment")
json.UpdateString("message.attachments[1].name","hedgehogs.jpg")
json.UpdateString("message.attachments[1].contentType","image/jpeg")
json.UpdateInt("message.attachments[1].size",jpgHedgeHogs.get_NumBytes())
json.UpdateBool("message.attachments[1].isInline",true)
# This contentId must match the "cid:" in the HTML
json.UpdateString("message.attachments[1].contentId","hedgehogs")
json.UpdateNull("message.attachments[1].contentLocation")
json.UpdateBd("message.attachments[1].contentBytes","base64",jpgHedgeHogs)

json.UpdateBool("saveToSentItems",true)

# -------------------------------------------------------------
# Important: This example requires Chilkat v9.5.0.68 or greater.
# -------------------------------------------------------------

# Send the HTTP POST (i.e. send the HTML email)
# resp is a CkHttpResponse
resp = http.PostJson3("https://graph.microsoft.com/v1.0/me/sendMail","application/json",json)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

# The send succeeded if the response status code = 202.
# In the success case, there is no response body.  (We just get the response code to know that it succeeded.)
if (resp.get_StatusCode() != 202)
    json.Load(resp.bodyStr())
    json.put_EmitCompact(false)
    print json.emit() + "\n";
    print "Failed, response status code = " + resp.get_StatusCode().to_s() + "\n";
else
    print "Outlook HTML Mail Sent." + "\n";
end