Test Relay in Postman.

Quick start

1. Import both JSON files into Postman.
2. Select RelayMCP - Production as the active environment.
3. Set api_key to a scoped rl_live_... key. Keep it local and never commit the exported environment.
4. Run Domains → List available Free mail domains if you need a domain, then Inboxes → Create an inbox.
5. The create request automatically stores inbox_id and email_address for later requests.

Included workflows

• Inbox creation and metadata inspection
• Cursor-paginated message listing
• Full message, OTP, authentication-link, and attachment requests
• SSE event stream with after and limit
• Webhook creation, delivery history, and deletion

Inbox and message lifecycle actions are governed by Relay access controls and service policy.

Newman

Run the collection from CI or a terminal after configuring the environment file:

npx newman run postman/relaymcp.postman_collection.json
  -e postman/relaymcp.postman_environment.json
  --reporters cli

Newman exits non-zero for failed assertions or an unavailable credential. The checked-in environment contains no secret.

Troubleshooting

401 UNAUTHORIZED

Set a valid, non-revoked api_key in the active environment.

403 INSUFFICIENT_SCOPE

Create a key with the scope required by the request, such as messages:read or webhooks:write.

429

Per-key API rate limits are enforced. Slow the runner and retry later.

Empty messages

This is a valid result. Message and OTP requests need an incoming message before they can return useful content.