(PureBasic) 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 PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkEmail.pb"

Procedure ChilkatExample()

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

    success.i

    ; Use the Chilkat Email API to create or load an email.
    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    CkEmail::ckAddTo(email,"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:
    CkEmail::setCkUncommonOptions(email, "UseBccHeader")
    CkEmail::ckAddBcc(email,"Joe","joe@example.com")
    CkEmail::ckAddBcc(email,"Dave","dave@example.com")
    ; ...
    ; -----------------------------------------------------------------------------------------

    CkEmail::setCkSubject(email, "This is a test GMail email created using Chilkat.")
    CkEmail::setCkCharset(email, "utf-8")
    CkEmail::ckAddPlainTextAlternativeBody(email,"This is a test")

    ; Create an HTML email body with an embedded image.
    cid.s = CkEmail::ckAddRelatedFile(email,"qa_data/jpg/starfish.jpg")
    sbHtml.i = CkStringBuilder::ckCreate()
    If sbHtml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbHtml,"<html><body>This is a <b>test</b><br><img src=" + Chr(34) + "cid:STARFISH_CID" + Chr(34) + "/></body></html>")
    numReplacements.i = CkStringBuilder::ckReplace(sbHtml,"STARFISH_CID",cid)

    CkEmail::ckAddHtmlAlternativeBody(email,CkStringBuilder::ckGetAsString(sbHtml))

    ; 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.i = CkStringBuilder::ckCreate()
    If sbMime.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkEmail::ckGetMimeSb(email,sbMime)
    CkStringBuilder::ckEncode(sbMime,"base64url","utf-8")

    ; The body of the HTTP request will be JSON..
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateSb(json,"raw",sbMime)

    ; Send the email...
    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, "GMAIL-ACCESS-TOKEN")

    url.s = "https://www.googleapis.com/gmail/v1/users/me/messages/send"
    resp.i = CkHttp::ckPostJson3(http,url,"application/json",json)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkEmail::ckDispose(email)
        CkStringBuilder::ckDispose(sbHtml)
        CkStringBuilder::ckDispose(sbMime)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    ; A status code of 200 indicates success.
    Debug "Response status code: " + Str(CkHttpResponse::ckStatusCode(resp))
    Debug "Response body:"
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)

    ; 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"
    ;  ]
    ; }


    CkEmail::ckDispose(email)
    CkStringBuilder::ckDispose(sbHtml)
    CkStringBuilder::ckDispose(sbMime)
    CkJsonObject::ckDispose(json)
    CkHttp::ckDispose(http)


    ProcedureReturn
EndProcedure