Check starred status - Automate.ax

gmail.checkWhetherMessageIsStarred checks whether a message has Gmail’s STARRED label.

Example

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

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

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

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

Inputs

Name	Type	Required	Description
`messageId`	`string`	Yes	Immutable Gmail message ID to inspect.
Second argument: `{ account }`	`string \| Google account reference`	No	Google Account binding. Defaults to the project binding.

Inputs accept compatible signals.

Output

Returns Signal<boolean> indicating whether the message has STARRED. This checks Gmail’s STARRED state but doesn’t distinguish the visual star styles configured in Gmail.