Is unread - Automate.ax

gmail.checkWhetherMessageIsUnread checks whether a message has Gmail’s UNREAD label.

Example

Mark each newly received message as read only if it remains unread when the action runs:

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

export default automation("Read new Gmail messages", () => {
  const email = gmail.onNewEmail()
  const unread = gmail.checkWhetherMessageIsUnread({
    messageId: email.messageId,
  })

  branch(unread, () => {
    gmail.markMessagesAsRead({ 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 UNREAD. Read state is message-level. In a conversation, other messages in the same thread can have a different state.