Install guide

Connect Plumail to Codex

Codex reads MCP servers from its configuration file, or from its command line.

  1. Create an API key

    In your Plumail workspace: Settings → API → New key. Name it, tick the permissions, save. The key is shown ONCE — copy it immediately. It starts with plm_live_ followed by thirty-two characters.

  2. From the command line

    Replacing YOUR_KEY. This is the fastest path — it writes directly to the configuration.

    codex mcp add plumail \
      --transport http \
      --url https://plumail.fr/api/mcp \
      --header "Authorization: Bearer YOUR_KEY"
  3. Or manually, in ~/.codex/config.toml

    If your version of Codex does not support the mcp subcommand, write the same thing in the configuration file.

    [mcp_servers.plumail]
    url = "https://plumail.fr/api/mcp"
    
    [mcp_servers.plumail.headers]
    Authorization = "Bearer YOUR_KEY"
  4. Check that it's connected

    Ask for the account status. This is read-only: nothing is modified, nothing is sent. The response names your workspace and lists your verified sending domains — those are the addresses you can send from.

    In the session: "What Plumail workspace do you see, and which sending domains are verified?"

Troubleshooting

Every API error carries a readable code. Here are the ones you encounter when connecting.

401 invalid_api_keyThe key is incomplete (a newline crept in during copy-paste) or has been replaced. Create a new one.
401 revoked_api_keyThe key was cut under Settings → API. Create another one.
403 insufficient_scopeThe key does not have the required permission. Permissions are chosen at creation and cannot be changed: create a key with the right scope.
422 unverified_from_domainThe sending address is not on a verified domain in the workspace. The error message lists the ones that are. To add one: Domains → Add a domain, then set the DNS records.
429 rate_limit_exceededMore than 600 requests per minute for this key. The Retry-After header says how many seconds to wait.