Unstar - Automate.ax

unstar removes Gmail’s STARRED system label from one or many messages. Use it after an automation has completed the work represented by a standard Gmail star.

Example

Remove the star from messages after applying a Completed label:

import { automation } from "automate.ax"
import { addLabel, onNewEmail, unstar } from "automate.ax/gmail"

export default automation("Complete starred Gmail work", () => {
  const email = onNewEmail()
  const completedMessageIds = addLabel({
    label: "Completed",
    messageIds: email.messageId,
  })

  unstar({ messageIds: completedMessageIds })
})

The Completed label must already exist in the selected Gmail account.

Inputs

Name	Type	Required	Description
`messageIds`	`string \| string[]`	Yes	One or up to 1,000 immutable Gmail message IDs.
`account`	`string \| Google account reference`	No	Google account binding to use. Defaults to the project’s default Google account.

Every input field also accepts a compatible Signal; the example chains the output of addLabel into unstar.

Output

The action returns a Signal<string[]> containing the modified message IDs in input order. This removes the standard STARRED label from individual messages. It does not change unrelated labels or other messages in the same thread.

⌘I