PureBasic GMail: Get a specific message (format="full")

Back to Index

Gets a specific message using format=full.

Documentation: https://developers.google.com/gmail/api/v1/reference/users/messages/get


IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ;   Provide a previously obtained OAuth2 access token.
    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkOAuth2::setCkAccessToken(oauth2, "OAUTH2_ACCESS_TOKEN")
    CkRest::ckSetAuthOAuth2(rest,oauth2)

    success = CkRest::ckConnect(rest,"www.googleapis.com",443,1,1)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    CkRest::ckAddPathParam(rest,"messageId","15fc23688c553739")

    CkRest::ckAddQueryParam(rest,"format","full")

    sbJson.i = CkStringBuilder::ckCreate()
    If sbJson.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodySb(rest,"GET","/gmail/v1/users/me/messages/messageId",sbJson)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkOAuth2::ckDispose(oauth2)
        CkStringBuilder::ckDispose(sbJson)
        ProcedureReturn
    EndIf

    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Received error response code: " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response body:"
        Debug CkStringBuilder::ckGetAsString(sbJson)
        CkRest::ckDispose(rest)
        CkOAuth2::ckDispose(oauth2)
        CkStringBuilder::ckDispose(sbJson)
        ProcedureReturn
    EndIf

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(json,sbJson)

    ;  The following code parses the JSON response.
    ;  A sample JSON response is shown below the sample code.
    id.s
    threadId.s
    snippet.s
    historyId.s
    internalDate.s
    payloadPartId.s
    payloadMimeType.s
    payloadFilename.s
    payloadBodySize.i
    sizeEstimate.i
    i.i
    count_i.i
    strVal.s
    name.s
    value.s
    partId.s
    mimeType.s
    filename.s
    bodySize.i
    bodyAttachmentId.s
    j.i
    count_j.i
    k.i
    count_k.i
    bodyData.s
    i1.i
    count_i1.i
    json1.i

    id = CkJsonObject::ckStringOf(json,"id")
    threadId = CkJsonObject::ckStringOf(json,"threadId")
    snippet = CkJsonObject::ckStringOf(json,"snippet")
    historyId = CkJsonObject::ckStringOf(json,"historyId")
    internalDate = CkJsonObject::ckStringOf(json,"internalDate")
    payloadPartId = CkJsonObject::ckStringOf(json,"payload.partId")
    payloadMimeType = CkJsonObject::ckStringOf(json,"payload.mimeType")
    payloadFilename = CkJsonObject::ckStringOf(json,"payload.filename")
    payloadBodySize = CkJsonObject::ckIntOf(json,"payload.body.size")
    sizeEstimate = CkJsonObject::ckIntOf(json,"sizeEstimate")
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(json,"labelIds")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        strVal = CkJsonObject::ckStringOf(json,"labelIds[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(json,"payload.headers")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        name = CkJsonObject::ckStringOf(json,"payload.headers[i].name")
        value = CkJsonObject::ckStringOf(json,"payload.headers[i].value")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(json,"payload.parts")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        partId = CkJsonObject::ckStringOf(json,"payload.parts[i].partId")
        mimeType = CkJsonObject::ckStringOf(json,"payload.parts[i].mimeType")
        filename = CkJsonObject::ckStringOf(json,"payload.parts[i].filename")
        bodySize = CkJsonObject::ckIntOf(json,"payload.parts[i].body.size")
        bodyAttachmentId = CkJsonObject::ckStringOf(json,"payload.parts[i].body.attachmentId")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(json,"payload.parts[i].headers")
        While j < count_j
            CkJsonObject::setCkJ(json, j)
            name = CkJsonObject::ckStringOf(json,"payload.parts[i].headers[j].name")
            value = CkJsonObject::ckStringOf(json,"payload.parts[i].headers[j].value")
            j = j + 1
        Wend
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(json,"payload.parts[i].parts")
        While j < count_j
            CkJsonObject::setCkJ(json, j)
            partId = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].partId")
            mimeType = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].mimeType")
            filename = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].filename")
            bodySize = CkJsonObject::ckIntOf(json,"payload.parts[i].parts[j].body.size")
            bodyAttachmentId = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].body.attachmentId")
            k = 0
            count_k = CkJsonObject::ckSizeOfArray(json,"payload.parts[i].parts[j].headers")
            While k < count_k
                CkJsonObject::setCkK(json, k)
                name = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].headers[k].name")
                value = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].headers[k].value")
                k = k + 1
            Wend
            k = 0
            count_k = CkJsonObject::ckSizeOfArray(json,"payload.parts[i].parts[j].parts")
            While k < count_k
                CkJsonObject::setCkK(json, k)
                partId = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].parts[k].partId")
                mimeType = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].parts[k].mimeType")
                filename = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].parts[k].filename")
                bodySize = CkJsonObject::ckIntOf(json,"payload.parts[i].parts[j].parts[k].body.size")
                bodyData = CkJsonObject::ckStringOf(json,"payload.parts[i].parts[j].parts[k].body.data")

                json1 = CkJsonObject::ckObjectOf(json,"payload.parts[i].parts[j].parts[k]")
                i1 = 0
                count_i1 = CkJsonObject::ckSizeOfArray(json1,"headers")
                While i1 < count_i1
                    CkJsonObject::setCkI(json1, i1)
                    name = CkJsonObject::ckStringOf(json1,"headers[i].name")
                    value = CkJsonObject::ckStringOf(json1,"headers[i].value")
                    i1 = i1 + 1
                Wend
                CkJsonObject::ckDispose(json1)

                k = k + 1
            Wend
            j = j + 1
        Wend
        i = i + 1
    Wend

    Debug "Example Completed."


    CkRest::ckDispose(rest)
    CkOAuth2::ckDispose(oauth2)
    CkStringBuilder::ckDispose(sbJson)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Sample JSON Response Body

{
  "id": "15fc23688c553739",
  "threadId": "15fc23688c553739",
  "labelIds": [
    "IMPORTANT",
    "SENT",
    "INBOX"
  ],
  "snippet": "This is a test. \u200b",
  "historyId": "1438",
  "internalDate": "1510791874000",
  "payload": {
    "partId": "",
    "mimeType": "multipart/mixed",
    "filename": "",
    "headers": [
      {
        "name": "MIME-Version",
        "value": "1.0"
      },
      {
        "name": "Received",
        "value": "by 10.25.23.105 with HTTP; Wed, 15 Nov 2017 16:24:34 -0800 (PST)"
      },
      {
        "name": "X-Originating-IP",
        "value": "[2601:249:e00:9093:e894:b27f:e5d6:d01d]"
      },
      {
        "name": "Date",
        "value": "Wed, 15 Nov 2017 18:24:34 -0600"
      },
      {
        "name": "Delivered-To",
        "value": "matt@chilkat.io"
      },
      {
        "name": "Message-ID",
        "value": "\u003cCAPhjyBM1qqXS6NVB65W8Zt5-McF03qWSRDjW5am66wTMuard=w@mail.gmail.com\u003e"
      },
      {
        "name": "Subject",
        "value": "Test HTML email with image and attachment."
      },
      {
        "name": "From",
        "value": "Matt Fausey \u003cmatt@chilkat.io\u003e"
      },
      {
        "name": "To",
        "value": "Matt Fausey \u003cmatt@chilkat.io\u003e"
      },
      {
        "name": "Content-Type",
        "value": "multipart/mixed; boundary=\"001a11401a6c097887055e0ea572\""
      }
    ],
    "body": {
      "size": 0
    },
    "parts": [
      {
        "partId": "0",
        "mimeType": "multipart/related",
        "filename": "",
        "headers": [
          {
            "name": "Content-Type",
            "value": "multipart/related; boundary=\"001a11401a6c097885055e0ea571\""
          }
        ],
        "body": {
          "size": 0
        },
        "parts": [
          {
            "partId": "0.0",
            "mimeType": "multipart/alternative",
            "filename": "",
            "headers": [
              {
                "name": "Content-Type",
                "value": "multipart/alternative; boundary=\"001a11401a6c097882055e0ea570\""
              }
            ],
            "body": {
              "size": 0
            },
            "parts": [
              {
                "partId": "0.0.0",
                "mimeType": "text/plain",
                "filename": "",
                "headers": [
                  {
                    "name": "Content-Type",
                    "value": "text/plain; charset=\"UTF-8\""
                  },
                  {
                    "name": "Content-Transfer-Encoding",
                    "value": "quoted-printable"
                  }
                ],
                "body": {
                  "size": 22,
                  "data": "VGhpcyBpcyBhIHRlc3QuDQrigIsNCg=="
                }
              },
              {
                "partId": "0.0.1",
                "mimeType": "text/html",
                "filename": "",
                "headers": [
                  {
                    "name": "Content-Type",
                    "value": "text/html; charset=\"UTF-8\""
                  },
                  {
                    "name": "Content-Transfer-Encoding",
                    "value": "quoted-printable"
                  }
                ],
                "body": {
                  "size": 115,
                  "data": "PGRpdiBkaXI9Imx0ciI-VGhpcyBpcyBhIHRlc3QuPGltZyB3aWR0aD0iMTIwIiBoZWlnaHQ9IjEyMCIgc3JjPSJjaWQ6aWlfamExcWY5MGwwXzE1ZmMyMzUzOWJkMDA3MjciPjxicj7igIs8L2Rpdj4NCg=="
                }
              }
            ]
          },
          {
            "partId": "0.1",
            "mimeType": "image/jpeg",
            "filename": "starfish.jpg",
            "headers": [
              {
                "name": "Content-Type",
                "value": "image/jpeg; name=\"starfish.jpg\""
              },
              {
                "name": "Content-Disposition",
                "value": "inline; filename=\"starfish.jpg\""
              },
              {
                "name": "Content-Transfer-Encoding",
                "value": "base64"
              },
              {
                "name": "Content-ID",
                "value": "\u003cii_ja1qf90l0_15fc23539bd00727\u003e"
              },
              {
                "name": "X-Attachment-Id",
                "value": "ii_ja1qf90l0_15fc23539bd00727"
              },
              {
                "name": "MIME-Version",
                "value": "1.0"
              },
              {
                "name": "Date",
                "value": "Wed, 15 Nov 2017 16:23:08 -0800"
              },
              {
                "name": "Message-ID",
                "value": "\u003cCAPhjyBMicJ9k-EXY5Efcvp8o_z_J3x8_G=mnC_znLXnyBogemQ@mail.gmail.com\u003e"
              },
              {
                "name": "Subject",
                "value": "Attachment"
              },
              {
                "name": "From",
                "value": "Matt Fausey \u003cmatt@chilkat.io\u003e"
              }
            ],
            "body": {
              "attachmentId": "ANGjdJ_ueuzzM9bpQ8l_tD27oDfn-smCe77viIAF1wy8ZeI09tK5vAuSS6V9Bahow4ikqaGleXqdQBeq8xhFkJ7WN-KKBSKvOfT2yD-XMlA1FC8AOKS2A8tBi5dDDbFrbnns33rfqEIRFAISslhdE481uB6sYfVoYjpuDThtW6Y96YA0Aso0P9txbKJwcwOeD0RxDav_vPzDjHuRuOYsGxbVTxesMB2eiMMw3i1y-WAu-pyWHqF0xMFehZmd7d-krKKdvI4UEgtzD9siXnnaH6MG55ykjBsjFRsmjKc-4K5fHeYHOf586Pkej5K238A",
              "size": 6229
            }
          }
        ]
      },
      {
        "partId": "1",
        "mimeType": "application/pdf",
        "filename": "helloWorld.pdf",
        "headers": [
          {
            "name": "Content-Type",
            "value": "application/pdf; name=\"helloWorld.pdf\""
          },
          {
            "name": "Content-Disposition",
            "value": "attachment; filename=\"helloWorld.pdf\""
          },
          {
            "name": "Content-Transfer-Encoding",
            "value": "base64"
          },
          {
            "name": "X-Attachment-Id",
            "value": "f_ja1qgya31"
          }
        ],
        "body": {
          "attachmentId": "ANGjdJ934ScA-kvdsvBvOjO9z-RYmRLyO8PvqOCzwkk-smeLVpKqeoxXNIn9FL_RbzA6qmTWKQTJehrBVmX4NqYtFsivmwRfzIWj-A-SqvJATRhjEGOntUeBS0fPZ9xy_enmH5Qgi0iSdBmwAn1CBnNghEKdMjvxTMjLxqn2mSO4gvxIh8ahJZDMN1p8KMYO98dM2XfyNndltnK-sd_DizNR9BQu10w5WSTLeFfOh61SxGKeq4Dt3W5USQlx7dEG7dRiBDvjFM6wo2HVeSnGEVphOwx80t1MQdhRN-YOHCAahIqy7Z0-BkPIIjTeUtl_pST8oMi0IgJoo9x1oomY3JZp2OxWuNyOVWDGVsDavGHc6wRhwK5pJrDceCWxNdPEwExeYA84WOAFXE2D6I3m",
          "size": 934
        }
      }
    ]
  },
  "sizeEstimate": 11716
}