(Ruby) Send GMail with BCC Recipients using REST API

See more GMail REST API Examples

Demonstrates how to send an email with BCC recipients using the GMail REST API.

Note: This example requires Chilkat v9.5.0.91 or greater.

Chilkat Ruby Downloads

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

require 'chilkat'

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

# Use the Chilkat Email API to create or load an email.
email = Chilkat::CkEmail.new()

# The From name/address don't need to be specified. 
# GMail will automatically use your Gmail address if the following 2 lines are omitted.
email.put_FromName("My Name")
email.put_FromAddress("my_account_name@gmail.com")

email.AddTo("John Smith","somebody@somewhere.com")
# To add more recipients, make additional calls to AddTo or AddCC, one per recipient...

# -----------------------------------------------------------------------------------------
# This section of this example demonstrates how to add BCC recipients.
# 
# Technically, an email should never contain a "Bcc" MIME header because it would
# effectively nullify the purpose of BCC -- which means "Blind Carbon Copy".
# Email recipients should not be able to see the BCC recipients.
# Chilkat never adds a "Bcc" header field.
# However.. in this case, the GMail REST server will look for the Bcc header field,
# and will include those email addresses when sending, and also removes the Bcc header
# from the email that is sent.
# 
# Starting in Chilkat v9.5.0.91, we can tell the email object to add the Bcc header
# using the "UseBccHeader" UncommonOptions.  For example:
email.put_UncommonOptions("UseBccHeader")
email.AddBcc("Joe","joe@example.com")
email.AddBcc("Dave","dave@example.com")
# ...
# -----------------------------------------------------------------------------------------

email.put_Subject("This is a test GMail email created using Chilkat.")
email.put_Charset("utf-8")
email.AddPlainTextAlternativeBody("This is a test")

# Create an HTML email body with an embedded image.
cid = email.addRelatedFile("qa_data/jpg/starfish.jpg")
sbHtml = Chilkat::CkStringBuilder.new()
sbHtml.Append("<html><body>This is a <b>test</b><br><img src=\"cid:STARFISH_CID\"/></body></html>")
numReplacements = sbHtml.Replace("STARFISH_CID",cid)

email.AddHtmlAlternativeBody(sbHtml.getAsString())

# OK.. we now have an HTML email with an embedded JPG image
# We'll need to get the full MIME of the email encoded to a base64url string.
sbMime = Chilkat::CkStringBuilder.new()
email.GetMimeSb(sbMime)
sbMime.Encode("base64url","utf-8")

# The body of the HTTP request will be JSON..
json = Chilkat::CkJsonObject.new()
json.UpdateSb("raw",sbMime)

# Send the email...
http = Chilkat::CkHttp.new()
http.put_AuthToken("GMAIL-ACCESS-TOKEN")

url = "https://www.googleapis.com/gmail/v1/users/me/messages/send"
# resp is a CkHttpResponse
resp = http.PostJson3(url,"application/json",json)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

# A status code of 200 indicates success.
print "Response status code: " + resp.get_StatusCode().to_s() + "\n";
print "Response body:" + "\n";
print resp.bodyStr() + "\n";

# The response body contains JSON.
# Use the online tool at Generate JSON Parsing Code
# to generate JSON parsing code.

# A sample successful JSON response:

# {
#  "id": "166f0d4ac39e50bf",
#  "threadId": "166f0d4ac39e50bf",
#  "labelIds": [
#   "SENT"
#  ]
# }