Swift

Find a Label ID by Name

See more GMail REST API Examples

Lookup the ID of a GMail label by the label name. Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!
    http.authToken = "GMAIL-ACCESS-TOKEN"

    var userId: String? = "me"
    http.setUrlVar(name: "userId", value: userId)

    var url: String? = "https://www.googleapis.com/gmail/v1/users/{$userId}/labels"

    // Get the list of GMail labels as JSON.
    let sb = CkoStringBuilder()!
    success = http.quickGetSb(url: url, sbContent: sb)
    if success != true {
        print("\(http.lastErrorText!)")
        return
    }

    let json = CkoJsonObject()!
    json.loadSb(sb: sb)
    json.emitCompact = false
    print("\(json.emit()!)")

    if http.lastStatus.intValue != 200 {
        print("Failed.")
        return
    }

    // The JSON returned looks like this:
    // {
    //   "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"
    //     },
    // 	...

    // The name of the label is generally known because it's what we visually see.
    // The id is what we need to get.  Assuming the name is unique,
    // find the JSON record having name=<desired name>
    // For example...
    var jRecord: CkoJsonObject? = json.findRecord(arrayPath: "labels", relPath: "name", value: "QA", caseSensitive: false)
    if json.lastMethodSuccess == true {
        print("The id of QA is: \(jRecord!.string(of: "id")!)")
        jRecord = nil
    }

    jRecord = json.findRecord(arrayPath: "labels", relPath: "name", value: "[Gmail]/testFolder", caseSensitive: false)
    if json.lastMethodSuccess == true {
        print("The id of [Gmail]/testFolder is: \(jRecord!.string(of: "id")!)")
        jRecord = nil
    }

    jRecord = json.findRecord(arrayPath: "labels", relPath: "name", value: "questions", caseSensitive: false)
    if json.lastMethodSuccess == true {
        print("The id of questions is: \(jRecord!.string(of: "id")!)")
        jRecord = nil
    }

    // Output:

    // The id of QA is: Label_5
    // The id of [Gmail]/testFolder is: Label_21
    // The id of questions is: Label_43

}