Ruby

Get GMail Message Metadata

See more GMail REST API Examples

Demonstrates how to get the metadata for each message in a list of message IDs. Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

http.put_AuthToken("ACCESS_TOKEN")

http.put_Accept("application/json")

# Let's say we have the following JSON containing a list of message ID's

# {
#   "messages": [
#     {
#       "id": "1712bc1dc22da2a2",
#       "threadId": "1712bc1dc22da2a2"
#     },
#     {
#       "id": "1712b94fa2168040",
#       "threadId": "1712b94fa2168040"
#     },
#     {
#       "id": "1711e4bd96ded05e",
#       "threadId": "1711e4bd96ded05e"
#     },
#     {
#       "id": "1711de0d119e751e",
#       "threadId": "1711de0d119e751e"
#     },
#     {
#       "id": "1711c81a43050f59",
#       "threadId": "1711c81a43050f59"
#     },
#     {
#       "id": "1711c2c1516abce5",
#       "threadId": "1711c2c1516abce5"
#     },
#     {
#       "id": "1711c161e655c915",
#       "threadId": "1711c161e655c915"
#     },
#     {
#       "id": "171199c6e454558c",
#       "threadId": "171199c6e454558c"
#     },
#     {
#       "id": "17119474c8aa248e",
#       "threadId": "17119474c8aa248e"
#     }
#   ],
#   "nextPageToken": "16710921492249671162",
#   "resultSizeEstimate": 309
# }

# Normally your program would have the above JSON in a string variable (obtained from a previous call to get
# a list of message IDs from a GMail mailbox).  In this example, we'll load the JSON from a file.
jsonMsgIds = Chilkat::CkJsonObject.new()
success = jsonMsgIds.LoadFile("qa_data/json/gmail_message_ids.json")

resp = Chilkat::CkHttpResponse.new()

i = 0
count_i = jsonMsgIds.SizeOfArray("messages")
while i < count_i
    jsonMsgIds.put_I(i)
    id = jsonMsgIds.stringOf("messages[i].id")

    # Get the metadata for this message ID.
    http.SetUrlVar("id",id)

    success = http.HttpNoBody("GET","https://www.googleapis.com/gmail/v1/users/userId/messages/{$id}?format=metadata",resp)
    if (success == false)
        print http.lastErrorText() + "\n";
        exit
    end

    print "Response Status Code: " + resp.get_StatusCode().to_s() + "\n";

    jsonResponse = Chilkat::CkJsonObject.new()
    jsonResponse.Load(resp.bodyStr())
    jsonResponse.put_EmitCompact(false)
    print jsonResponse.emit() + "\n";

    if (resp.get_StatusCode() != 200)
        print "Failed." + "\n";
        exit
    end

    i = i + 1
end

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON