Getting Started

First steps

1. Sign up and log in
2. Go to Domains and add your domain
3. Add an MX record pointing to your server at your DNS provider (details) — or use the dev-verify toggle for local testing
4. Go to Accounts and create an email address on that domain
5. Send an email to that address from your app
6. Open the account in Mail — your email should be there

You can also use any email client over SMTP and the API.

Over the API

The same flow, scripted. Create a key on the API Keys page first; the MX record from step 3 still has to exist.

curl -X POST https://stmp.ink/api/domains \
  -H "X-API-KEY: *** \
  -H "Content-Type: application/json" \
  -d '{"domain": "test.example.com"}'

curl -X POST https://stmp.ink/api/accounts \
  -H "X-API-KEY: *** \
  -H "Content-Type: application/json" \
  -d '{"address": "qa@test.example.com", "password": "use-a-secret"}'

Or send your first message with smtplib and read it back over the API:

import smtplib
from email.message import EmailMessage

msg = EmailMessage()
msg["From"] = "app@example.com"
msg["To"] = "qa@test.example.com"
msg["Subject"] = "Hello"
msg.set_content("It works.")

with smtplib.SMTP("stmp.ink", 2525) as smtp:
    smtp.send_message(msg)

Everything in the UI maps to a REST endpoint, so whatever you set up by hand you can also script.