Get profile - Automate.ax

getProfile returns basic information about the connected Gmail mailbox. Use it to identify the selected account or inspect mailbox-wide message and thread totals.

Example

automations/get-gmail-profile.automation.ts

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

export default automation("Get Gmail profile", () => {
  getProfile({})
})

Inputs

Property	Type	Required	Description
`account`	`string \| IntegrationAccountReference<"google">`	No	Google account binding to use. Defaults to the project’s default Google account binding.

The account can also be supplied by a compatible Signal.

Output

Returns a Signal<GmailProfile>:

interface GmailProfile {
  emailAddress: string
  historyId?: string
  messagesTotal?: number
  threadsTotal?: number
}

Property	Description
`emailAddress`	Primary email address of the authenticated Gmail account.
`historyId`	Current Gmail mailbox-history record ID, when supplied by Gmail.
`messagesTotal`	Total number of messages in the mailbox, when supplied by Gmail.
`threadsTotal`	Total number of threads in the mailbox, when supplied by Gmail.

The totals describe the entire mailbox; they are not counts for a search query or label.

⌘I