Getting started

Six steps from an empty server to an agent that can use your mail. Each one links to the full guide.

  1. Install

    Run the container or the binary behind HTTPS, with a master key and storage.

  2. Connect a mailbox

    Choose the providers your server offers. iCloud, Fastmail and Yahoo use an app password. Outlook and Gmail use an OAuth app you register once.

  3. Connect your agent

    Add your server's /mcp address to your agent app, then sign in with the mailbox you want it to use.

  4. Turn on new-mail alerts

    Turn on a webhook on your account page, and receive a small event, signed by default, when mail lands in the Inbox.

  5. Configure

    Every setting is an environment variable, with a matching serve flag.

Reference

Stuck? Check the FAQ, or open an issue in the repository.