Delete a draft

gmail.deleteDraft permanently removes an unsent draft.

Example

automations/delete-expired-draft.automation.ts

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

export default automation("Delete an expired Gmail draft", () => {
  onDashboardRun({ title: "Delete an expired Gmail draft" })

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

Inputs

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

Inputs accept compatible signals.

Gmail does not provide a way to restore a draft deleted by this action. Pass the draftId returned by a draft action, not the draft’s messageId.

The action fails if the draft was already sent or deleted, or belongs to a different connected account.

Output

Returns the deleted draftId as a Signal<string>.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output