/install gmail-imap
Gmail IMAP Skill
All Gmail access uses IMAP. Credentials are read from environment variables — never printed.
Requirements
Set these environment variables before use:
| Variable | Description |
|---|---|
GMAIL_IMAP_USER |
Your Gmail address (e.g. [email protected]) |
GMAIL_IMAP_PASSWORD |
A Google App Password (not your account password) |
Generate an App Password at: https://myaccount.google.com/apppasswords (requires 2FA enabled)
Quick Reference
# Locate the script (adjust SKILL_DIR to match your install location):
# Default: ~/.openclaw/skills/gmail-imap
# Custom: \x3Cworkspace>/skills/gmail-imap
SCRIPT="$SKILL_DIR/scripts/gmail_imap.py"
# List inbox (most recent 20)
"$SCRIPT" list
# List with custom limit
"$SCRIPT" list --limit 50
# List unread only (shorthand)
"$SCRIPT" list --unread
# List unread with limit
"$SCRIPT" list --unread --limit 10
# Search by sender (IMAP header search)
"$SCRIPT" list --search 'FROM "[email protected]"'
# Full-text search (Gmail X-GM-RAW — searches body + headers)
"$SCRIPT" search "invoice"
"$SCRIPT" search "from:[email protected] is:unread" --limit 5
"$SCRIPT" search "subject:meeting this week"
# Read a message (by UID shown in list output)
"$SCRIPT" read \x3Cuid>
# Read from a specific folder
"$SCRIPT" read \x3Cuid> --folder "[Gmail]/All Mail"
# Delete (moves to [Gmail]/Trash — correct Gmail deletion)
"$SCRIPT" trash \x3Cuid>
# Move to a label/folder
"$SCRIPT" move \x3Cuid> "Work"
# Send email
"$SCRIPT" send --to [email protected] --subject "Hello" --body "Message text"
Deletion Rule (Critical)
Never use the standard IMAP \Deleted flag on Gmail — it only archives, it does not delete.
Always use trash \x3Cuid> which moves to [Gmail]/Trash. The script handles this correctly.
Credentials
Set in env (never output raw password):
GMAIL_IMAP_USER— Gmail addressGMAIL_IMAP_PASSWORD— App password (generate at myaccount.google.com/apppasswords)
Reference
For folder names, search syntax, direct Python IMAP usage, and connection details: → See references/gmail-imap-reference.md
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install gmail-imap - After installation, invoke the skill by name or use
/gmail-imap - Provide required inputs per the skill's parameter spec and get structured output
What is Gmail IMAP?
Read, search, send, trash, move, and label Gmail via IMAP. Requires GMAIL_IMAP_USER (Gmail address) and GMAIL_IMAP_PASSWORD (Google App Password) environment... It is an AI Agent Skill for Claude Code / OpenClaw, with 67 downloads so far.
How do I install Gmail IMAP?
Run "/install gmail-imap" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Gmail IMAP free?
Yes, Gmail IMAP is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Gmail IMAP support?
Gmail IMAP is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Gmail IMAP?
It is built and maintained by scottgl9 (@scottgl9); the current version is v1.1.1.