name: imap-smtp-email description: Read and send email via IMAP/SMTP. Check for new/unread messages, fetch content, search mailboxes, mark as read/unread, and send emails with attachments. Supports multiple accounts. Works with any IMAP/SMTP server including Gmail, Outlook, 163.com, vip.163.com, 126.com, vip.126.com, 188.com, and vip.188.com. metadata: openclaw: emoji: "📧" requires: bins: - node - npm env: - PROVIDER - USERNAME - PASSWORD primaryEnv: PROVIDER
Read, search, and manage email via IMAP protocol. Send email via SMTP. Supports Gmail, Outlook, 163.com, vip.163.com, 126.com, vip.126.com, 188.com, vip.188.com, and any standard IMAP/SMTP server.
Run the setup script to install dependencies and configure your email account:
bash setup.sh
If running commands manually without setup.sh, install dependencies first:
npm install --production
Configuration is stored at ~/.config/mail-skills/.env (shared with caldav-sync skill, survives skill updates). If no shared config is found, the skill checks ~/.config/imap-smtp-email/.env (legacy) and then a .env file in the skill directory.
# Default account
PROVIDER=163
USERNAME=your@163.com
PASSWORD=your_password
# File access whitelist (security)
ALLOWED_READ_DIRS=~/Downloads,~/Documents
ALLOWED_WRITE_DIRS=~/Downloads
The PROVIDER preset auto-fills IMAP/SMTP server settings. For custom servers:
PROVIDER=custom
USERNAME=your@email.com
PASSWORD=your_password
IMAP_HOST=imap.example.com
SMTP_HOST=smtp.example.com
If you have an existing ~/.config/imap-smtp-email/.env, it takes priority over the shared config. The format is:
# Default account (no prefix)
IMAP_HOST=imap.gmail.com
IMAP_PORT=993
IMAP_USER=your@email.com
IMAP_PASS=your_password
IMAP_TLS=true
IMAP_REJECT_UNAUTHORIZED=true
IMAP_MAILBOX=INBOX
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_SECURE=false
SMTP_USER=your@email.com
SMTP_PASS=your_password
SMTP_FROM=your@email.com
SMTP_REJECT_UNAUTHORIZED=true
# File access whitelist (security)
ALLOWED_READ_DIRS=~/Downloads,~/Documents
ALLOWED_WRITE_DIRS=~/Downloads
Run bash setup.sh to migrate your legacy config to the shared format.
You can configure additional email accounts in the same config file. Each account uses a name prefix (uppercase) on all variables.
Run the setup script and choose "Add a new account":
bash setup.sh
Or manually add prefixed variables to ~/.config/mail-skills/.env:
# Work account (WORK_ prefix)
WORK_PROVIDER=gmail
WORK_USERNAME=me@company.com
WORK_PASSWORD=app_password
Add --account <name> before the command:
node scripts/imap.js --account work check
node scripts/smtp.js --account work send --to foo@bar.com --subject Hi --body Hello
Without --account, the default (unprefixed) account is used.
work, 163, personal2)work and WORK refer to the same account.env is always uppercase (e.g., WORK_PROVIDER)ALLOWED_READ_DIRS and ALLOWED_WRITE_DIRS are shared across all accounts (always unprefixed)| Provider | IMAP Host | IMAP Port | SMTP Host | SMTP Port |
|---|---|---|---|---|
| 163.com | imap.163.com | 993 | smtp.163.com | 465 |
| vip.163.com | imap.vip.163.com | 993 | smtp.vip.163.com | 465 |
| 126.com | imap.126.com | 993 | smtp.126.com | 465 |
| vip.126.com | imap.vip.126.com | 993 | smtp.vip.126.com | 465 |
| 188.com | imap.188.com | 993 | smtp.188.com | 465 |
| vip.188.com | imap.vip.188.com | 993 | smtp.vip.188.com | 465 |
| yeah.net | imap.yeah.net | 993 | smtp.yeah.net | 465 |
| Gmail | imap.gmail.com | 993 | smtp.gmail.com | 587 |
| Outlook | outlook.office365.com | 993 | smtp.office365.com | 587 |
| QQ Mail | imap.qq.com | 993 | smtp.qq.com | 587 |
| exmail.qq.com | imap.exmail.qq.com | 993 | smtp.exmail.qq.com | 465 |
Important for Gmail:
- Gmail does not accept your regular account password
- You must generate an App Password: https://myaccount.google.com/apppasswords
- Use the generated 16-character App Password as IMAP_PASS / SMTP_PASS
- Requires Google Account with 2-Step Verification enabled
Important for 163.com: - Use authorization code (授权码), not account password - Enable IMAP/SMTP in web settings first
Check for new/unread emails.
node scripts/imap.js [--account <name>] check [--limit 10] [--mailbox INBOX] [--recent 2h]
Options:
- --limit <n>: Max results (default: 10)
- --mailbox <name>: Mailbox to check (default: INBOX)
- --recent <time>: Only show emails from last X time (e.g., 30m, 2h, 7d)
- --unseen: Only show unread messages
Fetch full email content by UID.
node scripts/imap.js [--account <name>] fetch <uid> [--mailbox INBOX]
After fetching emails, agent should identify messages that may require your urgent attention. The following types of emails should be flagged and echoed to your terminal:
Financial: invoices, payments, receipts, billing
Contracts: agreements, signatures, legal documents
Action Required: approvals, reviews, deadlines, meeting confirmations
Urgent: marked as high priority, or containing urgency indicators
Flagged emails are displayed with a [!] prefix for easy scanning:
text [!] Invoice #2024-001 from billing@company.com [!] Urgent: Contract review needed from legal@firm.com [!] Meeting confirmation: Q4 planning tomorrow 10am
Download all attachments from an email, or a specific attachment.
node scripts/imap.js [--account <name>] download <uid> [--mailbox INBOX] [--dir <path>] [--file <filename>]
Options:
- --mailbox <name>: Mailbox (default: INBOX)
- --dir <path>: Output directory (default: current directory)
- --file <filename>: Download only the specified attachment (default: download all)
Search emails with filters.
node scripts/imap.js [--account <name>] search [options]
Options:
--unseen Only unread messages
--seen Only read messages
--from <email> From address contains
--subject <text> Subject contains
--recent <time> From last X time (e.g., 30m, 2h, 7d)
--since <date> After date (YYYY-MM-DD)
--before <date> Before date (YYYY-MM-DD)
--limit <n> Max results (default: 20)
--mailbox <name> Mailbox to search (default: INBOX)
--sort <mode> uid (default, fast) or date (strict INTERNALDATE sort;
fetches all matches, use when mailbox has COPY'd/backdated mail)
Mark message(s) as read or unread.
node scripts/imap.js [--account <name>] mark-read <uid> [uid2 uid3...]
node scripts/imap.js [--account <name>] mark-unread <uid> [uid2 uid3...]
List all available mailboxes/folders.
node scripts/imap.js [--account <name>] list-mailboxes
List all configured email accounts.
node scripts/imap.js list-accounts
node scripts/smtp.js list-accounts
Shows account name, email address, server addresses, and configuration status.
Send email via SMTP.
node scripts/smtp.js [--account <name>] send --to <email> --subject <text> [options]
Required:
- --to <email>: Recipient (comma-separated for multiple)
- --subject <text>: Email subject, or --subject-file <file>
Optional:
- --body <text>: Plain text body
- --html: Send body as HTML
- --body-file <file>: Read body from file
- --html-file <file>: Read HTML from file
- --cc <email>: CC recipients
- --bcc <email>: BCC recipients
- --attach <file>: Attachments (comma-separated)
- --from <email>: Override default sender
Examples:
# Simple text email
node scripts/smtp.js send --to recipient@example.com --subject "Hello" --body "World"
# HTML email
node scripts/smtp.js send --to recipient@example.com --subject "Newsletter" --html --body "<h1>Welcome</h1>"
# Email with attachment
node scripts/smtp.js send --to recipient@example.com --subject "Report" --body "Please find attached" --attach report.pdf
# Multiple recipients
node scripts/smtp.js send --to "a@example.com,b@example.com" --cc "c@example.com" --subject "Update" --body "Team update"
Test SMTP connection by sending a test email to yourself.
node scripts/smtp.js [--account <name>] test
~/.config/mail-skills/.env (or ~/.config/imap-smtp-email/.env for legacy) with 600 permissions (owner read/write only)Connection timeout: - Verify server is running and accessible - Check host/port configuration
Authentication failed: - Verify username (usually full email address) - Check password is correct - For 163.com: use authorization code, not account password - For Gmail: regular password won't work — generate an App Password at https://myaccount.google.com/apppasswords
TLS/SSL errors:
- Match IMAP_TLS/SMTP_SECURE setting to server requirements
- For self-signed certs: set IMAP_REJECT_UNAUTHORIZED=false or SMTP_REJECT_UNAUTHORIZED=false
小葱技能7w4.net有更新,你可以访问看下。
bash
npx skills add https://github.com/gzlicanyi/mail-skills -s caldav-syncIssues and pull requests are welcome at github.com/gzlicanyi/mail-skills.
这个邮件工具质量可靠,能读取和发送邮件,支持多种主流邮箱服务同时管理多个账户。配置流程设计得比较友好,交互式向导让设置变得简单。安全保护机制做得不错,敏感操作有相应的限制措施。配置步骤稍显复杂,对技术基础有一定要求,需要仔细阅读文档才能顺利上手。总体来说是个成熟可用的工具。.