Skip to main content
This gets you from nothing installed to a delivered message. You need a verified domain and an API key from the dashboard.
1

Install the binary

Homebrew, Scoop, go install and a container image all work too. See Install.
2

Store your API key

You are prompted for the key, it gets verified against the API, and you are asked whether to add SMTP credentials as well. Answer no for now.
3

Rehearse the send

--dry-run prints the exact request that would go out and sends nothing:
Read it. The from address has to be on a domain you have verified, and the next command spends real quota.
4

Send it

Drop --dry-run and run it again:
Keep the id. It is what ties this message to the webhook events it will produce.
5

Watch what happens to it

Acceptance is not delivery. To see the outcome, run a listener and point a webhook endpoint at it:
mailkube delivers only to public https addresses, so this needs a tunnel in front of it. Receiving webhooks walks through the whole loop, including registering the endpoint while the listener is running.
Three pages pay off soonest:
  • Sending email for attachments, templates, tags, scheduling and the SMTP transport.
  • Scripting for why mailkube ... | jq . works without a format flag, and what to branch on.
  • Errors and exit codes for the exit-code contract, which is stable within a major version.
Every send from this tool is real and charged, including the one in step 4. There is no sandbox and no test key. Send to an address you control, and prefer a domain that is not the one your production mail leaves from, since bounces and complaints attach to the domain that sent them.