vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-10 01:18:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/plugins/_email_integration/AGENTS.md
frdel e138e33ca9 Add file-level DOX docs & update AGENTS indexes 
Add comprehensive file-level DOX documentation across the repo and update directory AGENTS.md indexes. Many new `*.py.dox.md` files were added under api, helpers, tools, plugins, extensions, webui, and other dirs to document endpoint purpose, ownership, runtime contracts, work guidance, and verification. Several AGENTS.md files were created or updated (agents profiles, api, docker, extensions, helpers, plugins, skills, webui components, etc.) to list child DOX files and clarify documentation/work guidance. Also add example and bundled profile DOX files (agent0, default, developer, hacker, researcher) and minor updates to helpers/dirty_json.py and its tests. These changes improve on-disk documentation coverage and establish the convention that each direct runtime file should have a matching `*.dox.md` describing its contracts and verification steps.
2026-06-08 12:41:53 +02:00

1 KiB
Raw Permalink Blame History

Email Integration Plugin DOX

Purpose

  • Own communicating with Agent Zero through email inboxes and SMTP replies.

Ownership

  • helpers/handler.py owns mailbox polling, state, dispatch, routing, and reply flow.
  • helpers/imap_client.py and helpers/smtp_client.py own inbound and outbound mail transports.
  • helpers/dispatcher.py, prompts/, and attachment helpers own routing decisions and message formatting.
  • api/, default_config.yaml, plugin.yaml, extensions/, and webui/ own tests, settings, metadata, hooks, and config UI.

Local Contracts

  • Treat mailbox credentials and downloaded attachments as sensitive.
  • Preserve UID/state tracking so restarts do not duplicate old mail.
  • Keep SMTP replies threaded and safe around user-visible errors.

Work Guidance

  • Coordinate polling, dispatch prompts, and WebUI settings when adding account or routing behavior.

Verification

  • Smoke-test connection checks, polling, attachment handling, dispatch routing, and SMTP replies when practical.

Child DOX Index

No child DOX files.