shibbirweb/sendmock repository overview

⁠SendMock

Catch the email, SMS, push notifications, payments and webhooks your app sends, and see them in a web UI. SendMock runs a local SMTP server and the provider APIs your app already talks to (Twilio, SendGrid, Stripe, FCM and more), so nothing reaches a real inbox, phone or card while you develop and test.

• Docs: https://shibbirweb.github.io/sendmock/docs/⁠
• Source and issues: https://github.com/shibbirweb/sendmock⁠
• Also on GitHub's registry: ghcr.io/shibbirweb/sendmock (the same image)

⁠Quick start

1. Start SendMock:

   docker run --rm -p 1025:1025 -p 8025:8025 shibbirweb/sendmock
   

   Copy

2. Point your app's SMTP settings at 127.0.0.1, port 1025, with no encryption.

3. Send a message from your app and open http://127.0.0.1:8025⁠ to see it.

⁠Docker Compose

Keeps captured mail and SMS across restarts:

services:
  sendmock:
    image: shibbirweb/sendmock
    ports:
      - "1025:1025"
      - "8025:8025"
    volumes:
      - sendmock-data:/data

volumes:
  sendmock-data:

Apps in the same Compose project reach it at sendmock:1025 (SMTP) and http://sendmock:8025 (web UI and API).

⁠Ports

⁠Tags

Every image is built for linux/amd64 and linux/arm64, signed with cosign (keyless, from this repository's release workflow), and published with an SBOM and build provenance.

⁠Settings

Any setting can be passed as an environment variable. The ones people use most in Docker:

The full list is in the configuration guide: https://shibbirweb.github.io/sendmock/docs/configuration/⁠

⁠Files the image reads

⁠Run it in CI (GitHub Actions)

jobs:
  test:
    runs-on: ubuntu-latest
    services:
      sendmock:
        image: shibbirweb/sendmock
        ports:
          - 1025:1025
          - 8025:8025

The runner waits for the image's health check before your steps start. In your tests, read what the app sent through the API, for example wait up to 10 seconds for an email:

curl "http://127.0.0.1:8025/api/v1/wait/[email protected]&timeout=10s"

⁠About the image

• Built FROM scratch: just the sendmock binary, CA certificates and empty /data, /config, /templates and /tmp folders.
• Runs as the non-root user 10001.
• Has a health check (sendmock health), so Compose and CI wait until it is ready.

More: the Docker guide covers your app in a container, webhooks back to your app, and Linux host networking: https://shibbirweb.github.io/sendmock/docs/connect/docker/⁠

⁠License

MIT or Apache-2.0, at your choice.