Get messages - Automate.ax

gmail.getMessages returns complete messages for up to 100 immutable Gmail message IDs. The action fetches messages concurrently and returns them in the same order as messageIds. It returns every attachment as a File.

Example

automations/read-messages.automation.ts

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

export default automation("Read Gmail messages", () => {
  gmail.getMessages({
    messageIds: ["18f2c7a9b4d12345", "18f2c7a9b4d67890"],
  })
})

Inputs

Property	Type	Required	Description
`messageIds`	`string[]`	Yes	One to 100 immutable Gmail message IDs.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"google">`	No	Google Account binding. Defaults to the project binding.

Inputs accept compatible signals. Limit or partition searches with more than 100 matches before passing their IDs here.

Output

Returns Signal<Message[]>. Each message contains:

interface Message {
  messageId: string
  threadId: string
  historyId?: string
  labelIds: string[]
  attachments: Attachment[]
  bcc: Mailbox[]
  cc: Mailbox[]
  deliveredTo?: string
  from?: Mailbox
  headers: { name: string; value: string }[]
  html?: string
  inReplyTo?: string
  receivedAt: Date | null
  references: string[]
  replyTo: Mailbox[]
  returnPath?: string
  rfc822MessageId?: string
  sender?: Mailbox
  sentAt?: Date
  sizeEstimate?: number
  snippet?: string
  subject: string
  text?: string
  to: Mailbox[]
}

interface Mailbox {
  address: string
  name?: string
}

interface Attachment {
  contentId?: string
  description?: string
  disposition?: "attachment" | "inline"
  file: File
  filename: string
  mimeType: string
  related: boolean
}

The action fails if Gmail can’t retrieve any requested message, so use IDs from the same connected mailbox.