Tcl GMail: List all GMail Labels

Back to Index

Lists all labels in the user's mailbox.

Documentation: https://developers.google.com/gmail/api/v1/reference/users/labels/list

CURL Command

curl -X GET https://www.googleapis.com/gmail/v1/users/me/labels \
    --header "Authorization: Bearer GMAIL_TOKEN"

Tcl Example

load ./chilkat.dll

set rest [new_CkRest]

#  URL: https://www.googleapis.com/gmail/v1/users/me/labels
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "www.googleapis.com" $port $bTls $bAutoReconnect]
if {[expr $success != 1]} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

CkRest_AddHeader $rest "Authorization" "Bearer GMAIL_TOKEN"

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/gmail/v1/users/me/labels" $sbResponseBody]
if {[expr $success != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
if {[expr $respStatusCode >= 400]} then {
    puts "Response Status Code = $respStatusCode"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jsonResponse [new_CkJsonObject]

CkJsonObject_LoadSb $jsonResponse $sbResponseBody

#  See the Online Tool for Generating JSON Parse Code

set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "labels"]
while {[expr $i < $count_i]} {
    CkJsonObject_put_I $jsonResponse $i
    set id [CkJsonObject_stringOf $jsonResponse "labels[i].id"]
    set name [CkJsonObject_stringOf $jsonResponse "labels[i].name"]
    set messageListVisibility [CkJsonObject_stringOf $jsonResponse "labels[i].messageListVisibility"]
    set labelListVisibility [CkJsonObject_stringOf $jsonResponse "labels[i].labelListVisibility"]
    set type [CkJsonObject_stringOf $jsonResponse "labels[i].type"]
    set i [expr $i + 1]
}

delete_CkRest $rest
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse

Sample JSON Response Body

{
  "labels": [
    {
      "id": "Label_5",
      "name": "QA",
      "messageListVisibility": "show",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "Label_21",
      "name": "[Gmail]/testFolder",
      "type": "user"
    },
    {
      "id": "CATEGORY_PERSONAL",
      "name": "CATEGORY_PERSONAL",
      "type": "system"
    },
    {
      "id": "Label_8",
      "name": "old",
      "type": "user"
    },
    {
      "id": "CATEGORY_SOCIAL",
      "name": "CATEGORY_SOCIAL",
      "type": "system"
    },
    {
      "id": "Label_7",
      "name": "labél with space",
      "type": "user"
    },
    {
      "id": "Label_41",
      "name": "QA/qa_fetchSingleAsMime",
      "type": "user"
    },
    {
      "id": "Label_4",
      "name": "[Imap]/Trash",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "Label_1",
      "name": "\"test\"",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "Label_6",
      "name": "QA/Entwürfe",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "CATEGORY_FORUMS",
      "name": "CATEGORY_FORUMS",
      "type": "system"
    },
    {
      "id": "Label_42",
      "name": "[Gmail]/フルタイムの共有ソリューションはjapan",
      "type": "user"
    },
    {
      "id": "Label_3",
      "name": "[Gmail]/ö",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "IMPORTANT",
      "name": "IMPORTANT",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "Label_2",
      "name": "[Gmail]/X&Y",
      "type": "user"
    },
    {
      "id": "CATEGORY_UPDATES",
      "name": "CATEGORY_UPDATES",
      "type": "system"
    },
    {
      "id": "CHAT",
      "name": "CHAT",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "SENT",
      "name": "SENT",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "INBOX",
      "name": "INBOX",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "TRASH",
      "name": "TRASH",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelHide",
      "type": "system"
    },
    {
      "id": "CATEGORY_PROMOTIONS",
      "name": "CATEGORY_PROMOTIONS",
      "type": "system"
    },
    {
      "id": "DRAFT",
      "name": "DRAFT",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "SPAM",
      "name": "SPAM",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelHide",
      "type": "system"
    },
    {
      "id": "STARRED",
      "name": "STARRED",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "UNREAD",
      "name": "UNREAD",
      "type": "system"
    }
  ]
}