Has label - Automate.ax

gmail.checkLabel reports whether a message has an existing user or system label.

Example

Archive new messages that already carry the Handled label:

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

export default automation("Archive handled Gmail messages", () => {
  const email = gmail.onNewEmail()
  const handled = gmail.checkLabel({
    label: "Handled",
    messageId: email.messageId,
  })

  branch(handled, () => {
    gmail.archiveMessages({ messageIds: email.messageId })
  })
})

Inputs

Name	Type	Required	Description
`label`	`string`	Yes	Existing label display name or immutable Gmail label ID.
`messageId`	`string`	Yes	Immutable Gmail message ID to inspect.
Second argument: `{ account }`	`string \| Google account reference`	No	Google Account binding. Defaults to the project binding.

Inputs accept compatible signals. Label IDs must match exactly. The action matches display names after trimming surrounding whitespace and ignoring capitalization.

Output

Returns Signal<boolean>: true when the message has the resolved label and false when that label exists but is absent.

A missing label is an error, not a false result. Labels belong to a specific Gmail account, so make sure label, messageId, and account refer to the same mailbox.