Sample code for 30+ languages & platforms
Swift Requires Chilkat v11.1.0+

Gmail IMAP: Workspace Domain-Wide Delegation

See more GMail SMTP/IMAP/POP Examples

Use a JSON service-account key to impersonate a Workspace user for IMAP with https://www.googleapis.com/auth/gmail.imap_admin. A Workspace administrator must authorize the service account's numeric OAuth client ID for this exact scope in domain-wide delegation. The impersonated user must have an active Gmail mailbox.

This IMAP-only scope reveals labels hidden by Show in IMAP and messages excluded by the user's folder-size limit. It does not authorize SMTP or POP and is not available for personal Gmail accounts or ordinary user-consent flows. Workspace administrative access policies still apply.

Protect the private key and limit who can execute the delegated application. The signed JWT exchange produces a short-lived token without a refresh token; obtain another when necessary and reconnect. Keep the computer clock accurate. This example lists folders and examines INBOX read-only without printing credentials.

Google documentation

Chilkat Swift Downloads

Swift

func chilkatTest() {
    var success: Bool = false

    //  Assumes Chilkat is unlocked. See Global Unlock Sample.

    var mailbox: String? = "user@example.com"
    let key = CkoJsonObject()!
    success = key.loadFile(path: "gmail-service-account.json")
    if success != true {
        print("Could not load the private service-account key.")
        return
    }

    if (key.string(ofEquals: "type", value: "service_account", caseSensitive: true) != true) || (key.jsonType(of: "private_key").intValue != 1) {
        print("Expected a Google service-account JSON key.")
        return
    }

    let auth = CkoAuthGoogle()!
    auth.jsonKey = key.emit()
    auth.subEmailAddress = mailbox
    auth.scope = "https://www.googleapis.com/auth/gmail.imap_admin"
    auth.expireNumSeconds = 3600
    let connection = CkoSocket()!
    connection.requireSslCertVerify = true
    success = connection.connect(hostname: "www.googleapis.com", port: 443, ssl: true, maxWaitMs: 10000)
    if success != true {
        print("Could not establish the Google token connection.")
        return
    }

    success = auth.obtainAccessToken(connection: connection)
    connection.close(maxWaitMs: 1000)
    if success != true {
        print("Check the key, domain-wide delegation client ID/scope, user, and computer clock.")
        return
    }

    let imap = CkoImap()!
    imap.ssl = true
    imap.port = 993
    imap.requireSslCertVerify = true
    imap.authMethod = "XOAUTH2"
    success = imap.connect(hostname: "imap.gmail.com")
    if success != true {
        print("Could not establish the Gmail IMAP TLS connection.")
        return
    }

    success = imap.login(login: mailbox, password: auth.accessToken)
    if success != true {
        imap.disconnect()
        print("IMAP authentication failed. Check the mailbox, scope, expiry, and account policy.")
        return
    }

    let folders = CkoMailboxes()!
    success = imap.mbxList(subscribed: false, reference: "", mbxPattern: "*", mboxes: folders)
    if success != true {
        imap.logout()
        imap.disconnect()
        print("Could not list Gmail folders.")
        return
    }

    //  With gmail.imap_admin, labels hidden by the user's Show in IMAP setting are included.
    var i: Int = 0
    while (i < folders.count.intValue) {
        print("\(folders.getName(index: i)!)")
        i = i + 1
    }

    success = imap.examineMailbox(mailbox: "INBOX")
    if success != true {
        imap.logout()
        imap.disconnect()
        print("Could not examine the impersonated user's INBOX.")
        return
    }

    print("INBOX messages: \(imap.numMessages.intValue)")
    imap.logout()
    imap.disconnect()

}