Get message

gmail.getMessage returns a complete message by immutable Gmail message ID. Attachments are always downloaded and returned as File objects. If you only need identifiers, use Search messages instead.

Example

automations/read-message.automation.ts

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

export default automation("Read a Gmail message", () => {
  gmail.getMessage({
    messageId: "18f2c7a9b4d12345",
  })
})

Inputs

Property	Type	Required	Description
`messageId`	`string`	Yes	Immutable Gmail message ID. This isn’t the `Message-ID` header defined by `RFC 5322`.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"google">`	No	Google Account binding. Defaults to the project binding.

Inputs accept compatible signals.

Output

Returns Signal<Message>:

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
}

Automate.ax derives text from html when the source message has no plain-text alternative. receivedAt is Gmail’s mailbox timestamp. sentAt comes from the sender-supplied Date header.

Keep messageId and rfc822MessageId separate. Gmail actions expect the immutable Gmail messageId; rfc822MessageId is the value from the email’s Message-ID header.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output