Draft email

gmail.draftEmail creates a message for review or later completion without sending it.

Example

automations/draft-follow-up.automation.ts

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

export default automation("Draft a customer follow-up", () => {
  onDashboardRun({ title: "Draft a customer follow-up" })

  gmail.draftEmail({
    to: "customer@example.com",
    subject: "Following up",
    text: "Hi! I drafted this message for review before it is sent.",
  })
})

Recipients, subject, and body are all optional, so the action can create an incomplete draft.

Inputs

Input	Type	Required	Default	Description
`to`	`Recipient \| Recipient[]`	No	None	Primary recipients.
`subject`	`string`	No	`""`	Draft subject.
`html`	`string`	No	None	HTML body.
`text`	`string`	No	Derived from `html`	Plain-text body.
`cc`	`Recipient \| Recipient[]`	No	None	Carbon-copy recipients.
`bcc`	`Recipient \| Recipient[]`	No	None	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.
`attachments`	`Attachment[]`	No	`[]`	Files and inline message parts.
`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. 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 message stored inside the draft.
`threadId`	`string`	Immutable Gmail thread ID containing the draft.
`historyId`	`string \| undefined`	Most recent mailbox history record affecting the draft message, when supplied.
`labelIds`	`string[]`	Labels applied to the draft message.

draftId and messageId are different identifiers. Pass draftId to gmail.getDraft, gmail.updateDraft, gmail.sendDraft, or gmail.deleteDraft.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output