Skip to content
UseMailxPublic

About

MailX CLI: a thin client over the MailX Product API

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

8 Commits

Folders and files

Repository files navigation

mailx-cli

The MailX developer CLI: a thin client over the MailX Product API — the same capability layer every SDK and the MCP server use. It contains no business logic of its own: every command is an HTTP call to a documented /v1 route.

Install

With Go installed:

go install github.com/UseMailx/mailx-cli/cmd/mailx-cli@latest

This installs a mailx-cli binary onto your $GOPATH/bin (or $GOBIN).

Prebuilt binaries (macOS, Linux, Windows) are attached to each release for anyone without a Go toolchain.

Configure

export MAILX_API_KEY=mx_...
export MAILX_API_BASE_URL=https://api.mailx.dev/v1   # optional; defaults to this. Point it at your
                                                       # self-hosted deployment instead if you run one.

Usage

mailx-cli whoami

mailx-cli domains   list | inspect | create | verify | delete [--yes]
mailx-cli domains   dkim <get|create|verify> DOMAIN_ID
mailx-cli domains   spf|dmarc <get|verify> DOMAIN_ID
mailx-cli domains   bimi <get|verify> DOMAIN_ID
mailx-cli templates list | get | preview | create | update | delete [--yes]
mailx-cli emails    list | get | diagnose | send
mailx-cli webhooks  list | get | create | delete [--yes] | rotate-secret | deliveries

Run mailx-cli --help for the full command list.

Example

mailx-cli whoami

mailx-cli domains create example.com
mailx-cli domains verify DOMAIN_ID

mailx-cli templates create --name welcome --subject "Welcome, {{name}}" --text "Hi {{name}}!"
mailx-cli templates preview TEMPLATE_ID

mailx-cli emails send --from hello@example.com --to dest@example.com \
  --template-id TEMPLATE_ID --var name=Ada \
  --idempotency-key my-unique-key-1

mailx-cli webhooks create --url https://example.com/hook --events email.delivered,email.bounced
mailx-cli webhooks rotate-secret WEBHOOK_ID
mailx-cli webhooks deliveries WEBHOOK_ID

License

MIT

About

MailX CLI: a thin client over the MailX Product API

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages