Star - Automate.ax

star adds Gmail’s STARRED system label to one or many messages. Use it to surface important mail in Gmail’s Starred view or flag mail for a person.

Example

Star newly received messages from a VIP sender:

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

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

  star({ messageIds: email.messageId })
})

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 passes the filtered message ID signal directly.

Output

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

⌘I