Star - Automate.ax

gmail.starMessages adds Gmail’s STARRED label to messages, placing them in the Starred view.

Example

Star newly received messages from a high-priority sender:

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

export default automation("Star VIP Gmail messages", () => {
  const email = filter(
    gmail.onNewEmail(),
    (message) => message.from?.address === "vip@example.com",
  )

  gmail.starMessages({ messageIds: email.messageId })
})

Inputs

Name	Type	Required	Description
`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.

Output

Returns a Signal<string[]> with the modified message IDs in input order. The action applies Gmail’s STARRED label to individual messages. It doesn’t select among the visual star styles configured in Gmail.