Introduction
# š¬ BaseMail - Onchain Email for AI Agents on Base
> Your agent gets a real email address, linked to its onchain identity. No human needed.
**TL;DR:** Own a Basename (`yourname.base.eth`)? Get `[email protected]` instantly. Sign with your Base wallet, send emails autonomously.
## Why BaseMail?
- **Built on Base Chain** ā Email identity tied to your onchain wallet on Base (Coinbase's L2) - **Basename integration** ā `.base.eth` holders get matching `@basemail.ai` addresses automatically - **SIWE authentication** ā Sign-In with Ethereum, no passwords or CAPTCHA needed - **Autonomous for AI agents** ā Register for services, submit forms, receive confirmations without human help - **Verifiable identity** ā Your email is cryptographically linked to your Base wallet address
BaseMail gives AI agents verifiable email identities on **Base Chain**: - ⨠**Basename holders** ā `yourname.base.eth` ā `[email protected]` - š **Any Base wallet** ā `[email protected]`
### How it works
``` Base Wallet ā SIWE Signature ā BaseMail Registration ā [email protected] ā ā Basename (.base.eth) Send & receive email autonomously ```
---
## š Wallet Setup (Choose One)
### Option A: Environment Variable (Recommended ā )
If you already have a wallet, just set the env var ā **no private key stored to file**:
```bash export BASEMAIL_PRIVATE_KEY="0x..." node scripts/register.js ```
> ā Safest method: private key exists only in memory.
---
### Option B: Specify Wallet Path
Point to your existing private key file:
```bash node scripts/register.js --wallet /path/to/your/private-key ```
> ā Uses your existing wallet, no copying.
---
### Option C: Managed Mode (Beginners)
Let the skill generate and manage a wallet for you:
```bash node scripts/setup.js --managed node scripts/register.js ```
> ā **Always encrypted** ā Private key protected with AES-256-GCM > - You'll set a password during setup (min 8 chars, must include letter + number) > - Password required each time you use the wallet > - Mnemonic displayed once for manual backup (never saved to file) > - Password input is masked (hidden) in terminal
---
## ā ļø Security Guidelines
1. **Never** commit private keys to git 2. **Never** share private keys or mnemonics publicly 3. **Never** add `~/.basemail/` to version control 4. Private key files should be chmod `600` (owner read/write only) 5. Prefer environment variables (Option A) over file storage 6. `--wallet` paths are validated: must be under `$HOME`, no traversal, max 1KB file size 7. Private key format is validated (`0x` + 64 hex chars) before use 8. Password input is masked in terminal (characters hidden) 9. This skill only signs SIWE authentication messages ā it **never sends funds or on-chain transactions**
### Recommended .gitignore
```gitignore # BaseMail - NEVER commit! .basemail/ **/private-key.enc ```
---
## š Quick Start
### 1ļøā£ Register
```bash # Using environment variable export BASEMAIL_PRIVATE_KEY="0x..." node scripts/register.js
# Or with Basename node scripts/register.js --basename yourname.base.eth ```
### 2ļøā£ Send Email
```bash node scripts/send.js "[email protected]" "Hello!" "Nice to meet you š¦" ```
### 3ļøā£ Check Inbox
```bash node scripts/inbox.js # List emails node scripts/inbox.js <email_id> # Read specific email ```
---
## š¦ Scripts
| Script | Purpose | Needs Private Key | |--------|---------|-------------------| | `setup.js` | Show help | ā | | `setup.js --managed` | Generate wallet (always encrypted) | ā | | `register.js` | Register email address | ā | | `send.js` | Send email | ā (uses token) | | `inbox.js` | Check inbox | ā (uses token) | | `audit.js` | View audit log | ā |
---
## š File Locations
``` ~/.basemail/ āāā private-key.enc # Encrypted private key (AES-256-GCM, chmod 600) āāā wallet.json # Wallet info (public address only) āāā token.json # Auth token (chmod 600) āāā audit.log # Operation log (no sensitive data) ```
---
## šØ Get a Basename-Linked Email
Want `[email protected]` instead of `[email protected]`?
1. Register a **Basename** (`.base.eth`) at https://www.base.org/names 2. Link it: `node scripts/register.js --basename yourname.base.eth`
Your Basename is your onchain identity on Base ā and BaseMail turns it into a working email address.
---
## š§ API Reference
| Endpoint | Method | Purpose | |----------|--------|---------| | `/api/auth/start` | POST | Start SIWE auth | | `/api/auth/verify` | POST | Verify wallet signature | | `/api/register` | POST | Register email | | `/api/register/upgrade` | PUT | Upgrade to Basename | | `/api/send` | POST | Send email | | `/api/inbox` | GET | List inbox | | `/api/inbox/:id` | GET | Read email content |
**Full docs**: https://api.basemail.ai/api/docs
---
## š Links
- Website: https://basemail.ai - API: https://api.basemail.ai - API Docs: https://api.basemail.ai/api/docs - Get a Basename: https://www.base.org/names - Base Chain: https://base.org - Source: https://github.com/dAAAb/BaseMail-Skill
---
## š Changelog
### v1.8.0 (2026-02-18) - š Enhanced description: emphasize Base Chain and Basename (.base.eth) integration - š Added architecture diagram showing wallet ā SIWE ā email flow - š Better explanation of onchain identity and verifiable email - š Added source repo and Base Chain links
### v1.7.0 (2026-02-18) - š **Security hardening** (addresses ClawHub "Suspicious" classification): - Added OpenClaw metadata: declares `BASEMAIL_PRIVATE_KEY` in `requires.env` - Password input now masked in terminal (characters hidden as `*`) - Stronger password requirements: min 8 chars, must include letter + number - `--wallet` path validation: must be under `$HOME`, no `..` traversal, max 1KB, regular file only - Private key format validation (`0x` + 64 hex chars) on all input sources - Removed `--no-encrypt` option ā managed wallets are always encrypted - Mnemonic is displayed once and never saved to file (removed save-to-file prompt) - Removed legacy plaintext key file references - š Added `notes` in metadata clarifying: this skill only signs SIWE messages, never sends funds - š Updated security guidelines and file locations documentation
### v1.4.0 (2026-02-08) - ⨠Better branding and descriptions - š Full English documentation
### v1.1.0 (2026-02-08) - š Security: opt-in private key storage - ⨠Support env var, path, auto-detect - š Encrypted storage option (--encrypt) - š Audit logging
### v1.6.0 (Security Update) - š **Breaking**: `--managed` now encrypts by default - š Removed auto-detection of external wallet paths (security improvement) - š Mnemonic no longer auto-saved; displayed once for manual backup - š Updated documentation for clarity
### v1.0.0 - š Initial release