quickstart.mdx

title	Quickstart
description	Get your AI agent its own email address in two commands.
icon	rocket

Get your AI agent its own email address in two commands.

Prerequisites

• Node.js 20+
• OpenMail account (free, no credit card)

Inside Claude Code, run: ``` /plugin marketplace add openmailsh/skills /plugin install openmail@openmailsh-skills ``` Claude Code now knows how to use OpenMail. In your terminal: ```bash npx @openmail/cli setup --agent claude-code ``` This opens your browser to sign in, prompts for a mailbox name, creates your inbox, and writes credentials to `~/.claude/openmail.env`. ```bash npx @openmail/cli status ``` Your agent can now send and receive email. Ask Claude Code to send a test email to confirm. Paths, WebSocket bridge, and links to the packaged skill files. `SKILL.md` matches [`@openmail/cli`](https://github.com/openmailsh/cli); reference pages come from [openmailsh/skills](https://github.com/openmailsh/skills).

<div className="openmail-prompt-card">
<Prompt
  description="Use this pre-built prompt to get started faster."
  icon="wand-sparkles"
  actions={["copy", "cursor"]}
>
Read https://docs.openmail.sh/quickstart then add OpenMail to our OpenClaw agent:

1. `npm install -g @openmail/cli`
2. Ask the user for their API key (from https://console.openmail.sh/settings/api), inbox name, and display name, then run `openmail setup --api-key "<key>" --mailbox-name "<name>" --display-name "<display name>" --mode notify`
</Prompt>
</div>

<Steps>
  <Step title="Install">
    ```bash
    npm install -g @openmail/cli
    ```
  </Step>
  <Step title="Setup">
    ```bash
    openmail setup
    ```
    Creates your inbox, writes the skill file to `~/.openclaw/skills/openmail/SKILL.md`, and saves credentials to `~/.openclaw/openmail.env`. Pass `--api-key om_...` to skip the auth prompt.

    When setup completes, confirm everything is working:
    ```bash
    openmail status
    ```
    <Note>
      **WebSocket bridge** — Setup starts the bridge automatically via systemd (Linux) or launchd (macOS). On Windows, setup prints the command to run manually.
    </Note>
  </Step>
  <Step title="Send an email">
    ```bash
    openmail send --to hello@example.com --subject "Hello from OpenMail" --body "I have my own inbox!"
    ```
    Add files with `--attach` (repeatable):
    ```bash
    openmail send --to hello@example.com --subject "Report" --body "See attached" --attach report.pdf
    ```
  </Step>
</Steps>

See the [API integration guide](/guides/api-integration) for creating inboxes and sending email programmatically with any language or framework.

More commands

openmail messages list --direction inbound
openmail threads list
openmail threads get --thread-id <thread-id>

Next steps

• OpenClaw - See the OpenClaw integration guide and the Skill files tab for SKILL.md and reference files.
• Handle inbound email - Route replies to your agent via WebSocket or webhooks.
• Improve deliverability - Follow warm-up schedules to stay out of spam.
• Explore the API - Full API reference for programmatic workflows.

Real-time event streaming. No public URL needed. Warm-up schedules and content best practices. How threads work across inbound and outbound. Create inboxes programmatically for multi-tenant apps.