← All toolsCommunicationemailAll editions

READ_EMAILS

Read recent emails from a mailbox folder.

Parameters

NameTypeRequiredDescription
countstring—Number of emails to read (default 5)
folderstring—IMAP folder to read from (default INBOX)

How to use it

You normally trigger this by describing what you want in chat — the agent selects READ_EMAILS automatically. For example:

Try saying
“read my email”

In a workflow

As a step in a multi-step workflow DAG:

json
{
  "id": "s1",
  "agent": "email",
  "action": "READ_EMAILS",
  "args": {
    "count": "…",
    "folder": "…"
  },
  "depends_on": [],
  "outputs": []
}

Direct call

For scripting, call it directly via POST /execute_tool. Every tool returns { success, message, data }.

bash
curl -X POST http://127.0.0.1:8000/execute_tool \
  -H "Content-Type: application/json" \
  -d '{"tool_name":"READ_EMAILS","args":{"count":"…","folder":"…"}}'

Part of the email plugin. Browse the full Plugin & Tool Catalog or the relevant feature guide.