Send email

gmail.sendEmail sends a message to known recipients. It can start a conversation or add a follow-up to an existing thread, including when nobody has replied yet.

Example

automations/send-report.automation.ts

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

export default automation("Send the weekly report", () => {
  onDashboardRun({ title: "Send the weekly report" })

  gmail.sendEmail({
    to: { address: "reader@example.com", name: "Report reader" },
    subject: "Your weekly report",
    markdown: "# Weekly report\n\nThe report is **ready**.",
  })
})

Provide at least one of text, markdown, or html. Automate.ax preserves supplied plain-text and HTML bodies. Markdown generates either missing alternative. Otherwise, HTML generates plain text, and plain text generates HTML.

Inputs

Input	Type	Required	Default	Description
`to`	`Recipient \| Recipient[]`	Yes	None	One or more primary recipients.
`subject`	`string`	Yes	None	Message subject.
`threadId`	`string`	No	New conversation	Existing Gmail thread. Also supply its matching subject and `In-Reply-To` and `References` headers.
`text`	`string`	One body required	Derived when omitted	Plain-text body.
`markdown`	`string`	One body required	None	Markdown body used to generate missing alternatives.
`html`	`string`	One body required	Derived when omitted	HTML 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 used to send the message.

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.

Gmail may reject or replace a from address that is not configured as a send-as alias on the connected account.

The message carries an authenticated automation origin. Gmail triggers don’t wake the automation that sent it, while other automations watching the mailbox still receive the event.

Output

Returns Signal<MessageMetadata>:

Property	Type	Description
`messageId`	`string`	Immutable Gmail ID of the sent message.
`threadId`	`string`	Immutable Gmail ID of its conversation.
`historyId`	`string \| undefined`	Most recent mailbox history record affecting the message, when Gmail supplies it.
`labelIds`	`string[]`	Gmail system and user label IDs applied to the message.

Keep messageId for actions that operate on one message and threadId for actions that operate on the conversation. For a follow-up, read the conversation with gmail.getThread. Pass its threadId, preserve the subject, and set headers["In-Reply-To"] to the preceding message’s rfc822MessageId. Set headers.References to that message’s references followed by its rfc822MessageId, joined with spaces. Keep to set to your intended recipients. These are Gmail’s threading requirements.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output