Search threads

gmail.searchThreads returns each matching conversation once, even when several messages match the Gmail search query. The action returns identifiers only. Pass a result to Get thread to retrieve and parse every message in the conversation.

Example

automations/find-customer-threads.automation.ts

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

export default automation("Find recent customer threads", () => {
  gmail.searchThreads({
    query: "from:customer@example.com newer_than:90d",
    limit: 50,
  })
})

Inputs

Property	Type	Required	Default	Description
`query`	`string`	No	None	Query using Gmail search-box syntax. An omitted or empty query doesn’t filter by query text.
`labelIds`	`string[]`	No	None	Gmail label IDs that every returned thread must carry. These are IDs, not display names.
`includeSpamTrash`	`boolean`	No	`false`	Whether threads in Spam and Trash may match.
`limit`	`number`	No	`100`	Maximum total results. Must be an integer from 1 to 10,000.
Second argument: `{ account }`	`string \| IntegrationAccountReference<"google">`	No	Project default	Google Account binding to search.

Inputs accept compatible signals.

Output

Returns Signal<ThreadIdentifier[]>:

interface ThreadIdentifier {
  threadId: string
}

The action fetches additional Gmail result pages internally until it reaches limit or exhausts the search.

Choose Search messages when you need a separate result for each matching email. Choose gmail.searchThreads when you need one result per conversation.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output