Trash

gmail.trashMessages moves messages to Trash, where they remain recoverable while Gmail retains them.

Example

Trash newly received messages with a known test marker:

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

export default automation("Trash Gmail test messages", () => {
  const testMessage = filter(gmail.onNewEmail(), (message) =>
    message.subject.includes("[TEST]"),
  )

  gmail.trashMessages({ messageIds: testMessage.messageId })
})

Inputs

Name	Type	Required	Description
`messageIds`	`string \| string[]`	Yes	One or up to 1,000 immutable Gmail message IDs.
Second argument: `{ account }`	`string \| Google account reference`	No	Google Account binding. Defaults to the project binding.

Inputs accept compatible signals.

Output

Returns a Signal<Array<{ messageId: string; threadId: string; historyId?: string; labelIds: string[] }>> with each message’s updated metadata in input order.

Field	Type	Description
`messageId`	`string`	Immutable Gmail message ID.
`threadId`	`string`	Immutable ID of the thread containing the message.
`historyId`	`string \| undefined`	Most recent mailbox history record affecting the message, when Gmail supplies it.
`labelIds`	`string[]`	Gmail system and user label IDs applied after the operation.

Trashing is not permanent deletion, but Gmail can permanently delete retained Trash contents. gmail.untrashMessages can restore a message only while Gmail still has it.

The action operates on individual message IDs. Trashing one message doesn’t explicitly trash every message in its thread.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output