Draft reply

gmail.draftReply derives a reply’s recipient, subject, and conversation headers from a Gmail message and saves it in the same thread.

Example

automations/draft-inbox-reply.automation.ts

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

export default automation("Draft replies to new email", () => {
  const email = gmail.onNewEmail()

  gmail.draftReply({
    messageId: email.messageId,
    text: "Thanks for your message. A teammate will review this reply.",
  })
})

The messageId must identify the message you want to answer, not merely another message in the same thread.

Inputs

Input	Type	Required	Default	Description
`messageId`	`string`	Yes	None	Immutable Gmail ID of the message receiving the reply.
`replyAll`	`boolean`	No	`false`	Include the original To and Cc recipients. Omit the connected account and primary reply address.
`html`	`string`	No	None	HTML reply body.
`text`	`string`	No	Derived from `html`	Plain-text reply body.
`to`	`Recipient \| Recipient[]`	No	None	Additional primary recipients appended to the derived recipient.
`cc`	`Recipient \| Recipient[]`	No	None	Additional carbon-copy recipients.
`bcc`	`Recipient \| Recipient[]`	No	None	Additional blind-copy recipients.
`from`	`Recipient`	No	Gmail account address	Sender address or configured Gmail send-as alias.
`replyTo`	`Recipient \| Recipient[]`	No	None	Addresses that should receive replies to this draft.
`attachments`	`Attachment[]`	No	`[]`	Files and inline message parts attached to the reply.
`headers`	`Record<string, string>`	No	None	Additional `RFC 5322` headers.
`priority`	`"high" \| "normal" \| "low"`	No	Not set	Importance encoded in standard message headers.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"google">`	No	Project default	Connected Google Account that owns the draft.

Recipient is an email string or { address: string; name?: string }. Attachment is a File or an object containing file with optional filename, contentId, and disposition: "attachment" | "inline". Inputs accept compatible signals.

replyAll: true may add every original To and Cc recipient. Review the draft before sending when the conversation contains sensitive recipients.

Gmail must return the source message’s thread ID, subject, standard Message-ID, and either Reply-To or From header. The action fails if those reply headers are missing. The draft carries an authenticated automation origin. If it’s sent later, Gmail triggers don’t wake the automation that created it, while other automations watching the mailbox still receive the event.

Output

Returns Signal<DraftIdentifier>:

Property	Type	Description
`draftId`	`string`	Immutable Gmail draft ID. Use this with draft actions.
`messageId`	`string`	Immutable ID of the reply message stored in the draft.
`threadId`	`string`	Gmail thread containing the original message and reply draft.
`historyId`	`string \| undefined`	Most recent mailbox history record affecting the draft message, when supplied.
`labelIds`	`string[]`	Labels applied to the draft message.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output