Advanced Custom Actions

This example demonstrates how to use actionMeta in custom actions to pass data to subsequent actions.

In this scenario, a custom action custom.parseInvoice extracts an invoice number from the email body and stores it in actionMeta. This value is then accessible in the attachment.store action using the placeholder {{message.invoiceNumber}}.

👉 Edit this example in the playground.

Config

{
  "description": "Demonstrates how to use actionMeta to pass data between actions.",
  "settings": {
    "markProcessedMethod": "mark-read"
  },
  "global": {
    "thread": {
      "match": {
        "query": "has:attachment -in:trash -in:drafts -in:spam after:{{date.now|formatDate('yyyy-MM-dd')}} is:unread subject:\"[GmailProcessor-Test] customActionsAdvanced\""
      }
    }
  },
  "threads": [
    {
      "match": {
        "query": "from:{{user.email}}"
      },
      "messages": [
        {
          "actions": [
            {
              "name": "custom.parseInvoice"
            }
          ],
          "attachments": [
            {
              "match": {
                "name": "^invoice\\.pdf$"
              },
              "actions": [
                {
                  "name": "attachment.store",
                  "args": {
                    "location": "/GmailProcessor-Tests/e2e/customActionsAdvanced/{{message.invoiceNumber}}/{{attachment.name}}",
                    "conflictStrategy": "keep"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Script

function customActionsAdvancedRun() {
  const config = {
    description:
      "Demonstrates how to use actionMeta to pass data between actions.",
    settings: {
      markProcessedMethod: "mark-read",
    },
    global: {
      thread: {
        match: {
          query:
            "has:attachment -in:trash -in:drafts -in:spam after:{{date.now|formatDate('yyyy-MM-dd')}} is:unread subject:\"[GmailProcessor-Test] customActionsAdvanced\"",
        },
      },
    },
    threads: [
      {
        match: {
          query: "from:{{user.email}}",
        },
        messages: [
          {
            actions: [
              {
                name: "custom.parseInvoice",
              },
            ],
            attachments: [
              {
                match: {
                  name: "^invoice\\.pdf$",
                },
                actions: [
                  {
                    name: "attachment.store",
                    args: {
                      location:
                        "/GmailProcessor-Tests/e2e/customActionsAdvanced/{{message.invoiceNumber}}/{{attachment.name}}",
                      conflictStrategy: "keep",
                    },
                  },
                ],
              },
            ],
          },
        ],
      },
    ],
  }

  const customActions = [
    {
      name: "parseInvoice",
      action: (ctx, _args) => {
        // Ensure we have a message context (runtime check that also satisfies TS)
        if (!("message" in ctx)) return {}
        // @ts-ignore
        const body = ctx.message.object.getBody()
        const match = body.match(/Invoice Number: (INV-\d+)/)
        if (match && match[1]) {
          ctx.log.info(`Extracted invoice number: ${match[1]}`)
          // Store the extracted value in actionMeta to make it available as {{message.invoiceNumber}}
          return {
            "message.invoiceNumber": match[1],
          }
        }
        return {}
      },
    },
  ]
  return GmailProcessorLib.run(config, "dry-run", customActions)
}

Source: customActionsAdvanced.ts | Issues: #540