On label added - Automate.ax

gmail.onLabelAdded handles user and system label additions in the connected mailbox.

Example

automations/prioritize-customer-email.automation.ts

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

export default automation("Prioritize customer email", () => {
  const customerEmail = filter(gmail.onLabelAdded(), ({ labels }) =>
    labels.some(({ name }) => name === "Customer"),
  )

  gmail.markMessagesAsImportant({
    messageIds: customerEmail.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.onLabelAdded() without options to use the project binding.

Trigger data

Returns Signal<GmailLabelChange> for each Gmail history change:

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

message contains the same parsed fields as Get message. One event can contain several labels from the same Gmail history change. Use labelId as the stable identity. name is the current label name when available.