On label removed - Automate.ax

gmail.onLabelRemoved handles user and system label removals in the connected mailbox.

Example

automations/archive-resolved-email.automation.ts

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

export default automation("Archive resolved email", () => {
  const resolved = filter(gmail.onLabelRemoved(), ({ labels }) =>
    labels.some(({ name }) => name === "Needs reply"),
  )

  gmail.archiveMessages({
    messageIds: resolved.message.messageId,
  })
})

Options

Property	Type	Required	Description
`account`	`string \| IntegrationAccountReference<"google">`	No	Static Google Account binding. Defaults to the project binding.

The watched account can’t change at runtime. Call gmail.onLabelRemoved() without options to use the project binding.

Trigger data

Returns Signal<GmailLabelChange> with the parsed message and labels removed in the same Gmail history change:

interface GmailLabelChange {
  labels: {
    labelId: string
    name?: string
  }[]
  message: Message
}

See Get message for all Message fields. Use labelId as the stable identity. Gmail omits name when it can no longer resolve a removed label, such as after the user deletes it.