Archive - Automate.ax

gmail.archiveMessages removes Gmail’s INBOX label while keeping the messages available.

Example

Archive each new message after applying a record-keeping label:

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

export default automation("Archive processed Gmail messages", () => {
  const email = gmail.onNewEmail()
  const labeledMessageIds = gmail.addLabel({
    labels: ["Processed"],
    messageIds: email.messageId,
  })

  gmail.archiveMessages({ messageIds: labeledMessageIds })
})

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<string[]> with the modified message IDs in input order. Gmail doesn’t have a separate Archive folder. Archiving removes INBOX. It doesn’t trash or delete the messages, and other labels remain applied. The action changes the supplied messages rather than every message in their threads.