Remove label - Automate.ax

gmail.removeLabel removes labels from messages without deleting the labels.

Example

Remove the Triage label from each newly received message:

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

export default automation("Clear Gmail triage labels", () => {
  const email = gmail.onNewEmail()

  gmail.removeLabel({
    labels: ["Triage", "Needs review"],
    messageIds: email.messageId,
  })
})

Each label must 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. Removing a Gmail system label changes the corresponding state: for example, removing INBOX archives a message and removing UNREAD marks it as read. The action affects only the supplied messages. It doesn’t affect the label resource or other messages in their threads.