Is starred - Automate.ax

isStarred checks whether one Gmail message has the STARRED system label. Use the boolean result to route starred mail or avoid applying the same state twice.

Example

Remove the star from newly received messages that are already starred:

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

export default automation("Clear stars from new Gmail messages", () => {
  const email = onNewEmail()
  const starred = isStarred({ messageId: email.messageId })

  branch(starred, () => {
    unstar({ messageIds: email.messageId })
  })
})

Inputs

Name	Type	Required	Description
`messageId`	`string`	Yes	Immutable Gmail message ID to inspect.
`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 email.messageId directly.

Output

The action returns a Signal<boolean> indicating whether the message has Gmail’s STARRED label when the action runs. This checks Gmail’s STARRED state but does not distinguish the visual star styles configured in Gmail.

⌘I