ai-agent-email-skill

v1.0.5

This skill provides script-based email operations for an agent. It includes functionalities for managing mailboxes, reading/searching emails, sending/replyin...

0· 24·0 current·0 all-time
MIT-0
Download zip
LicenseMIT-0 · Free to use, modify, and redistribute. No attribution required.
Security Scan
VirusTotalVirusTotal
Benign
View report →
OpenClawOpenClaw
Benign
high confidence
Purpose & Capability
Name/description (email operations) align with required env vars (EMAIL_USERNAME, EMAIL_PASSWORD), the declared config path (./scripts/config.toml), and the included IMAP/SMTP scripts. No unrelated credentials or external services are requested.
Instruction Scope
SKILL.md and the scripts instruct the agent to load ./scripts/config.toml, read env vars for auth, and perform IMAP/SMTP network operations. The instructions do not direct reading unrelated system files or exfiltration to unexpected endpoints; the only external HTTP call is an OAuth2 token exchange to the token_url supplied in config or env.
Install Mechanism
Instruction-only install (no install spec). The skill ships Python scripts rather than downloading code at install time, so nothing is fetched from third-party URLs during installation.
Credentials
Requested secrets are proportional to an email client: EMAIL_USERNAME and EMAIL_PASSWORD (primary) and optional EMAIL_OAUTH2_* variables for OAuth. No unrelated tokens or high-privilege credentials are required. The code uses these vars only for IMAP/SMTP auth and optional OAuth token refresh.
Persistence & Privilege
always:false (normal). The skill can be invoked autonomously per platform defaults, which is expected for a programmatic email skill. It does not attempt to modify other skills or global agent settings.
Assessment
This skill will have direct access to your email account (it needs EMAIL_USERNAME and EMAIL_PASSWORD or OAuth2 tokens) and will connect to IMAP/SMTP servers specified in the local ./scripts/config.toml. Only install if you trust the skill and are comfortable granting mailbox access. Prefer using an app-specific password or OAuth where possible, and ensure the OAuth token endpoint (EMAIL_OAUTH2_TOKEN_URL) is a legitimate provider you trust. Protect ./scripts/config.toml and environment variables (restrict file permissions and avoid putting real passwords in shared environments). If you lose confidence in the skill, rotate credentials (passwords/refresh tokens) immediately. If you want extra assurance, review the included Python scripts yourself or run them in an isolated environment before granting real credentials.

Like a lobster shell, security has layers — review code before you run it.

latestvk97603ecvqndzzrt2wfmeez08h844kh3

License

MIT-0
Free to use, modify, and redistribute. No attribution required.

Runtime requirements

EnvEMAIL_PASSWORD, EMAIL_USERNAME
Config./scripts/config.toml
Primary envEMAIL_PASSWORD

SKILL.md

AI Agent Email Skill (aaes)

Overview

This skill provides script-based email operations for an agent. It includes functionalities for managing mailboxes, reading/searching emails, sending/replying/forwarding emails, and managing attachments, allowing agents to perform comprehensive email-related tasks programmatically.

Features

  • IMAP operations: Read, list, mark, move, delete, copy emails
  • SMTP operations: Send, reply, forward emails with attachments
  • Folder management: Create, delete, rename, list mailboxes
  • Dual-format bodies: Supports both plain-text and HTML, with automatic fallback generation
  • Attachment handling: Supports base64-encoded attachments
  • Multi-account support: Configure multiple accounts
  • Authentication: Password or OAuth2 via environment variables (auto-detected)
  • Signatures: Automatic signature appending to outgoing emails
  • Thread support: Proper In-Reply-To and References header handling

When to use

Use this skill when you need an agent to:

  • Check inbox for new emails and summarize them
  • Read specific emails and extract content
  • Send new emails with attachments
  • Reply to or forward emails
  • Organize emails by moving/copying between folders
  • Create or manage mailbox folders
  • Mark emails as read/unread, flagged, spam, or junk

Requirements

  • Python 3.14+
  • IMAP/SMTP access to your email provider
  • Network access to email servers

Configuration

Basic Setup

Configure this skill with ./scripts/config.toml:

  1. Copy ./config.default.toml to ./scripts/config.toml.
  2. Edit ./scripts/config.toml - fill in email address and server addresses.

Authentication Setup

Only one authentication method is required, Password-based or OAuth2.

Password-based authentication

VariableDescription
EMAIL_USERNAMELogin username (required)
EMAIL_PASSWORDUser password or app password
# Linux/Mac
export EMAIL_USERNAME="me"
export EMAIL_PASSWORD="my-password"

# Windows (PowerShell)
$env:EMAIL_USERNAME="me"
$env:EMAIL_PASSWORD="my-password"

# Windows (CMD)
set EMAIL_USERNAME=me
set EMAIL_PASSWORD=my-password

OAuth2 authentication

VariableDescription
EMAIL_OAUTH2_CLIENT_IDOAuth2 client ID
EMAIL_OAUTH2_CLIENT_SECRETOAuth2 client secret
EMAIL_OAUTH2_REFRESH_TOKENOAuth2 refresh token
EMAIL_OAUTH2_TOKEN_URLOAuth2 token endpoint URL
# Linux/Mac
export EMAIL_OAUTH2_CLIENT_ID="xxx"
export EMAIL_OAUTH2_CLIENT_SECRET="xxx"
export EMAIL_OAUTH2_REFRESH_TOKEN="xxx"
export EMAIL_OAUTH2_TOKEN_URL="https://oauth2.example.com/token"

# Windows (PowerShell)
$env:EMAIL_OAUTH2_CLIENT_ID="xxx"
$env:EMAIL_OAUTH2_CLIENT_SECRET="xxx"
$env:EMAIL_OAUTH2_REFRESH_TOKEN="xxx"
$env:EMAIL_OAUTH2_TOKEN_URL="https://oauth2.example.com/token"

# Windows (CMD)
set EMAIL_OAUTH2_CLIENT_ID=xxx
set EMAIL_OAUTH2_CLIENT_SECRET=xxx
set EMAIL_OAUTH2_REFRESH_TOKEN=xxx
set EMAIL_OAUTH2_TOKEN_URL="https://oauth2.example.com/token"

Test

# Linux/Mac
echo '{"requestId":"test","schemaVersion":"1.0","data":{"maxResults":5}}' | python3 scripts/mail_list.py

# Windows (PowerShell)
echo '{"requestId":"test","schemaVersion":"1.0","data":{"maxResults":5}}' | python scripts/mail_list.py

# Windows (CMD)
echo "{\"requestId\":\"test\",\"schemaVersion\":\"1.0\",\"data\":{\"maxResults\":5}}" | python scripts/mail_list.py

Data Exchange Contract

Overview

All scripts follow the same JSON-over-stdin contract:

  1. Agent sends one JSON object to stdin
  2. Script writes one JSON object to stdout
  3. Logs and diagnostics are written to stderr

Request Schema

{
  "requestId": "optional-trace-id",
  "schemaVersion": "1.0",
  "account": "optional-account-name-in-config",
  "data": {}
}

Success Response Schema

{
  "ok": true,
  "requestId": "same-as-request",
  "schemaVersion": "1.0",
  "data": {}
}

Error Response Schema

{
  "ok": false,
  "requestId": "same-as-request",
  "schemaVersion": "1.0",
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable message",
    "details": {}
  }
}
Error CodeDescription
VALIDATION_ERRORInvalid input data or parameters
CONFIG_ERRORConfiguration file missing or invalid
AUTH_ERRORAuthentication failed
NETWORK_ERRORNetwork connection failed
MAIL_OPERATION_ERRORIMAP/SMTP operation failed
MAILBOX_ERRORMailbox selection or management failed
INTERNAL_ERRORUnexpected internal error

Scripts

folder_create.py

Create mailbox folder.

Request fields
namestring, required
Response fields
accountAccount name used
nameFolder name created
createdtrue on success

folder_delete.py

Delete mailbox folder.

Request fields
namestring, required
Response fields
accountAccount name used
nameFolder name deleted
deletedtrue on success

folder_list.py

List mailbox folders.

Request fields
(none)
Response fields
accountAccount name used
mailboxesArray of folder objects

folder_rename.py

Rename mailbox folder.

Request fields
oldNamestring, required
newNamestring, required
Response fields
accountAccount name used
oldNameOriginal folder name
newNameNew folder name
renamedtrue on success

mail_copy.py

Copy email(s) between folders.

Request fields
uidsstring[] or comma-separated string
sourceFolderoptional, default INBOX
targetFolderrequired
Response fields
accountAccount name used
uidsUIDs copied
sourceFolderSource folder
targetFolderTarget folder
copiedtrue on success

mail_delete.py

Delete email(s).

Request fields
uidsstring[] or comma-separated string
folderoptional, default INBOX
expungeboolean, default false
Response fields
accountAccount name used
uidsUIDs deleted
folderFolder name
deletedtrue on success
expungedtrue if hard deleted

mail_forward.py

Forward email with optional additions.

Request fields
uidstring, required
folderoptional, default INBOX
tostring or string[], required
ccoptional
bccoptional
bodyTextoptional, prepended to forwarded content
bodyHtmloptional
attachmentsoptional
Response fields
accountAccount name used
forwardedtrue on success
uidOriginal email UID
toRecipients
ccCC recipients
subjectForwarded subject

Automatically includes original email and attachments.

mail_mark.py

Mark email(s) with flags.

Request fields
uidsstring[] or comma-separated string, required
markTyperead, unread, flag, unflag, spam, notspam, junk, notjunk, required
folderoptional, default INBOX
Response fields
accountAccount name used
uidsUIDs marked
markTypeMark type applied
markedtrue on success

mail_move.py

Move email(s) between folders.

Request fields
uidsstring[] or comma-separated string
sourceFolderoptional, default INBOX
targetFolderrequired
Response fields
accountAccount name used
uidsUIDs moved
sourceFolderSource folder
targetFolderTarget folder
movedtrue on success

mail_read.py

Read email content and metadata.

Request fields
uidstring, required
folderoptional, default INBOX
Response fields
accountAccount name used
uidEmail UID
subjectEmail subject
fromSender
toRecipients
ccCC recipients
dateEmail date
bodyTextPlain text body
bodyHtmlHTML body
attachmentsAttachment list
tagsCombined flags and labels

Marks message as read after fetch.

mail_reply.py

Reply to email.

Request fields
uidstring, required
folderoptional, default INBOX
bodyTextoptional
bodyHtmloptional
replyAllboolean, default false
priorityhigh, normal, low
attachmentsoptional
Response fields
accountAccount name used
uidOriginal email UID
folderOriginal email folder
senttrue on success
toReply recipients
ccCC recipients
attachmentCountNumber of attachments
priorityPriority level (high, normal, low)
readReceipttrue if read receipt requested
inReplyToIn-Reply-To message ID
referencesReferences header value
subjectReply subject

mail_list.py

List emails using IMAP search.

Request fields
queryoptional, default UNSEEN
folderoptional, default INBOX
maxResultsoptional, default 10
Response fields
accountAccount name used
folderFolder searched
querySearch query
uidsMatching UIDs
countResults returned
totalCountTotal matches
hasMoreMore results available
summaryEmail summaries
QueryDescription
UNSEENUnread messages
FROM user@example.comFrom sender
SUBJECT "keyword"Subject contains
SINCE 2024-01-01Since date
ALLAll messages

mail_send.py

Send new email.

Request fields
tostring or string[], required
subjectstring, required
bodyTextoptional
bodyHtmloptional
ccoptional
bccoptional
priorityhigh, normal, low
attachmentsoptional
Response fields
accountAccount name used
senttrue on success
toRecipients
ccCC recipients
bccCountNumber of BCC recipients
attachmentCountNumber of attachments
priorityPriority level (high, normal, low)
readReceipttrue if read receipt requested
inReplyToIn-Reply-To message ID
referencesReferences header value
subjectSent subject

Examples

List new emails

echo '{"requestId":"test","schemaVersion":"1.0","data":{"maxResults":10}}' | python3 scripts/mail_list.py

Read email by UID

{ "requestId": "read", "schemaVersion": "1.0", "data": { "uid": "123" } }

List from sender

{
  "requestId": "search",
  "schemaVersion": "1.0",
  "data": { "query": "FROM boss@example.com" }
}

Send email

{
  "requestId": "send",
  "schemaVersion": "1.0",
  "data": {
    "to": ["user@example.com"],
    "subject": "Hello",
    "bodyText": "Hello world!"
  }
}

Reply to email

{
  "requestId": "reply",
  "schemaVersion": "1.0",
  "data": { "uid": "123", "bodyText": "Thanks!" }
}

Mark and move

{"requestId":"mark","schemaVersion":"1.0","data":{"uids":"123","markType":"read"}}
{"requestId":"move","schemaVersion":"1.0","data":{"uids":"123","targetFolder":"Archive"}}

Troubleshooting

AUTH_ERROR

  • If password auth: Ensure both EMAIL_USERNAME and EMAIL_PASSWORD are set
  • If OAuth2 auth: All four variables required: EMAIL_OAUTH2_CLIENT_ID, EMAIL_OAUTH2_CLIENT_SECRET, EMAIL_OAUTH2_REFRESH_TOKEN, EMAIL_OAUTH2_TOKEN_URL
  • For 2FA accounts, use app password for EMAIL_PASSWORD
  • OAuth2 takes priority if all four EMAIL_OAUTH2_* variables are set

NETWORK_ERROR

  • Verify IMAP port 993 (SSL) or 143 (STARTTLS)
  • Verify SMTP port 465 (SSL) or 587 (STARTTLS)
  • Check firewall settings

CONFIG_ERROR

  • Ensure config.toml exists and is valid TOML
  • Check email, imap.host, smtp.host are configured

Security Warnings

⚠️ SSL Verification: Setting ssl_verify = false in config disables certificate validation and exposes connections to man-in-the-middle attacks. Only disable for local development/testing.

⚠️ IMAP Injection Protection: User-provided search queries are validated against a whitelist of safe commands. Custom queries containing ()"; characters will be rejected.

Debugging

Check stderr for detailed error logs with code, message, and details.

Files

24 total
Select a file
Select a file to preview.

Comments

Loading comments…