Add label

Example

Apply the Processed label to each newly received message:

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

export default automation("Label processed Gmail messages", () => {
  const email = gmail.onNewEmail()

  gmail.addLabel({
    labels: ["Processed", "Reviewed"],
    messageIds: email.messageId,
  })
})

Each label must already exist in the selected Gmail account.

Inputs

Name	Type	Required	Description
`labels`	`string \| string[]`	Yes	One or more label display names or immutable Gmail label IDs.
`messageIds`	`string \| string[]`	Yes	One or up to 1,000 immutable Gmail message IDs.
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. If any label doesn’t exist in the selected account, the action fails without modifying the messages.

Output

Returns a Signal<string[]> with the modified message IDs in input order.

This action updates messages, not entire threads, and does not create the label. Prefer dedicated actions such as gmail.archiveMessages, gmail.markMessagesAsSpam, and gmail.markMessagesAsRead when they express the system-label change you need.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output