List labels

gmail.listLabels returns every label in the connected mailbox, including immutable IDs for later actions.

Example

automations/list-gmail-labels.automation.ts

import { automation } from "automate.ax"
import { gmail } from "automate.ax/gmail"

export default automation("List Gmail labels", () => {
  gmail.listLabels()
})

Inputs

Property	Type	Required	Description
Second argument: `{ account }`	`string \| IntegrationAccountReference<"google">`	No	Google Account binding. Defaults to the project binding.

Second argument { account } accepts a compatible signal.

Output

Returns Signal<GmailLabel[]>. Each label contains:

interface GmailLabel {
  labelId: string
  name: string
  type?: "system" | "user"
  labelListVisibility?: "labelHide" | "labelShow" | "labelShowIfUnread"
  messageListVisibility?: "hide" | "show"
  color?: {
    backgroundColor: string
    textColor: string
  }
  messagesTotal?: number
  messagesUnread?: number
  threadsTotal?: number
  threadsUnread?: number
}

Gmail doesn’t supply every optional field for every label. For example, system labels and user labels can expose different visibility, color, and count metadata.

Use labelId for durable references and for labelIds search filters. Display names are intended for people and can be renamed.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output