On label removed - Automate.ax

onGmailLabelRemoved subscribes an automation to user-label and system-label removals in the connected Gmail mailbox.

Example

automations/archive-resolved-email.automation.ts

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

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

  archiveGmailMessages({
    messageIds: resolved.message.messageId,
  })
})

Options

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

The account selection must be static. Call onGmailLabelRemoved() without an options object to use the default Google binding.

Trigger data

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

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

See Get message for the complete Message shape. Use labelId as the stable identity. name is omitted when Gmail can no longer resolve a removed label, such as after the user deletes that label.

⌘I