Example Apps
If you want a runnable project instead of isolated code snippets, start with one of the official example repos.
Node.js and TypeScript
- Repo: postmx/node-example
- SDK docs: Node.js SDK
- Best for: backend apps, scripts, test automation, and TypeScript projects
What it shows:
- Creating a temporary inbox
- Waiting for the next inbound message
- Reading the OTP or first extracted link
- Running the flow from a small Node app
Basic run flow:
npm install
POSTMX_API_KEY=pmx_live_your_key_here npm start
Python
- Repo: postmx/python-example
- SDK docs: Python SDK
- Best for: smoke tests, scripts, workers, and simple backend tasks
What it shows:
- Creating a temporary inbox
- Waiting for the next inbound message
- Reading the OTP or first extracted link
- Running the flow from a small Python app
Basic run flow:
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
POSTMX_API_KEY=pmx_live_your_key_here python catch_login_email.py
Which one should you choose?
- Choose Node.js if your app or tests already run in JavaScript or TypeScript.
- Choose Python if you want a small script, smoke test, or worker-friendly integration.
- Use the SDK reference pages when you want method-by-method details.
- Use these example repos when you want a complete starting point you can run and modify.