Get a draft - Automate.ax

gmail.getDraft returns a draft with its parsed message for review, update, or sending.

Example

automations/load-draft.automation.ts

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

export default automation("Load a Gmail draft", () => {
  onDashboardRun({ title: "Load a Gmail draft" })

  gmail.getDraft({
    draftId: "r1234567890",
  })
})

Inputs

Input	Type	Required	Default	Description
`draftId`	`string`	Yes	None	Immutable Gmail draft ID.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"google">`	No	Project default	Connected Google Account that owns the draft.

Inputs accept compatible signals. Pass the draftId returned by gmail.draftEmail, gmail.draftReply, gmail.searchDrafts, or gmail.updateDraft. A draft’s messageId isn’t accepted here. The action fails if Gmail returns an incomplete draft or message.

Output

Returns Signal<Draft>:

Property	Type	Description
`draftId`	`string`	Immutable Gmail draft ID.
`message`	`GmailMessage`	Fully parsed message stored inside the draft.

Message

Property	Type	Description
`messageId`	`string`	Immutable Gmail message ID.
`threadId`	`string`	Immutable Gmail thread ID containing the draft.
`historyId`	`string \| undefined`	Most recent mailbox history record affecting the message, when supplied.
`labelIds`	`string[]`	Gmail system and user label IDs applied to the message.
`subject`	`string`	Decoded message subject. Empty when the draft has no subject.
`text`	`string \| undefined`	Plain-text body, derived from HTML when no text alternative exists.
`html`	`string \| undefined`	HTML body, when present.
`from`	`Mailbox \| undefined`	Parsed From address.
`sender`	`Mailbox \| undefined`	`Sender` header when distinct from `From`.
`to`	`Mailbox[]`	Primary recipients.
`cc`	`Mailbox[]`	Carbon-copy recipients.
`bcc`	`Mailbox[]`	Blind-copy recipients retained in the raw draft, when available.
`replyTo`	`Mailbox[]`	Addresses from the `Reply-To` header.
`deliveredTo`	`string \| undefined`	Address recorded by Delivered-To.
`returnPath`	`string \| undefined`	Address recorded by Return-Path.
`headers`	`MessageHeader[]`	Decoded `RFC 5322` headers with duplicates and original name casing preserved.
`rfc822MessageId`	`string \| undefined`	`RFC 5322` Message-ID from the message headers.
`inReplyTo`	`string \| undefined`	Message-ID of the message this draft replies to.
`references`	`string[]`	Message-IDs in the conversation ancestry.
`receivedAt`	`Date \| null`	Gmail mailbox time. `null` when Gmail supplies none.
`sentAt`	`Date \| undefined`	Date from the message headers when valid.
`sizeEstimate`	`number \| undefined`	Estimated raw message size in bytes.
`snippet`	`string \| undefined`	Short preview generated by Gmail.
`attachments`	`GmailAttachment[]`	Parsed attachments and inline message parts.

Mailbox is { address: string; name?: string }. MessageHeader is { name: string; value: string }. Each GmailAttachment contains:

Property	Type	Description
`file`	`File`	Parsed attachment contents and metadata.
`filename`	`string`	Filename presented by the sender.
`mimeType`	`string`	Media type.
`disposition`	`"attachment" \| "inline" \| undefined`	How the message presents the part.
`contentId`	`string \| undefined`	Content-ID referenced by related HTML.
`description`	`string \| undefined`	Human-readable part description, when present.
`related`	`boolean`	Whether the attachment belongs to a multipart/related body.