Developer docs
Proxy Mail QA gives every test account a real inbox. Create a disposable address, sign up with it in the app you’re testing, and get the verification code or link from the email the moment it lands, in one call that waits for it.
Start with one of these:
Set up your agentOne prompt for Claude Code, Cursor, GitHub Copilot or another coding agent. It connects itself; you sign in once.
MCP serverConnect an agent by hand, with an API key or browser sign-in, and the tools it gets.
REST APIFor test suites and scripts: create an address, then wait for the code or link.
Node.js clientnpm install proxymail-qa: the REST API with types, for Playwright, Cypress and scripts.
REST API referenceEvery endpoint, parameter and response, generated from the API itself.
Examples
Section titled “Examples”- Playwright: sign up and enter the code.
- Cypress: sign up and open the verification link.
- Puppeteer and Python (pytest with Selenium or Playwright).
- Running in CI: the API key as a secret, one address per run, and cloud coding agents.
- Mobile apps: Maestro, XCUITest, Espresso, Flutter, Detox and Appium.
Before you start
Section titled “Before you start”- You need a Proxy Mail QA account and a project: create one free. Agents that sign in by browser need nothing else; scripts and test suites need an API key.
- Your app has to be able to email any address. Email providers in sandbox or test mode only send to addresses you’ve verified: see Test email not arriving?.
- Proxy Mail QA is for testing apps you build or are allowed to test. See Limits and safety and the Terms.
Testing by hand rather than from code? Proxy Mail QA for Chrome fills sign-up forms with a test account and shows the code or link in the page.