# ScanMyPass Mail

> Self-hosted transactional email API. Customers verify their own sending domain over DNS,
> receive an API key, and send mail over REST with delivery tracking, bounce handling,
> suppression lists, attachments and webhooks.

Base URL: https://mail-api.scanmypass.com
Authentication: `Authorization: Bearer <api key>` on every endpoint except /health.
Sending is asynchronous: POST /v1/emails returns 202 queued, not delivered.

## Docs

These are the raw markdown sources. The same documents are rendered for humans
at https://khat.scanmypass.com/docs

- [API reference](https://mail-api.scanmypass.com/docs/api): Every endpoint, with cURL, JavaScript, Node, Python and PHP examples, including attachments.
- [DNS setup](https://mail-api.scanmypass.com/docs/dns): What each record does, how to publish it, and every common failure mode.
- [Deployment](https://mail-api.scanmypass.com/docs/deployment): VPS setup, outbound port 25, PTR records, TLS, IP warm-up, backups, scaling.
- [Operations](https://mail-api.scanmypass.com/docs/operations): Health checks, metrics, alerts, logs, abuse response, incident runbook.
- [Security](https://mail-api.scanmypass.com/docs/security): Threat model, secret handling, multi-tenancy, input validation.
- [Testing](https://mail-api.scanmypass.com/docs/testing): Running the suites and what each one covers.
- [Overview](https://mail-api.scanmypass.com/docs/readme): What the platform is, how the pieces fit together, and what is implemented.

## Optional

- [Health](https://mail-api.scanmypass.com/health): liveness probe.
- [Readiness](https://mail-api.scanmypass.com/ready): database, redis and MTA status.