README

Command-line interface for the Mailcore mail-server control API, built on Symfony Console.

Unofficial. Third-party tool; not published by Mailcore.

AI-assisted. Code, tests, and docs were written largely by AI (Claude Code) under human direction and review.

Built on the inboxcom/mailcore-php core client.

Install

As a project dependency:

composer require inboxcom/mailcore-cli
vendor/bin/mailcore list

…or globally, to get a mailcore command on your PATH:

composer global require inboxcom/mailcore-cli

Requires PHP >= 8.4.

Usage

The CLI covers every API operation — one command per endpoint, grouped as users:*, domains:*, mailboxplans:*, mailfilter:*, reports:*, datadump:*. Run mailcore list to see them all.

export MAILCORE_API_KEY=your-api-key

mailcore users:list --filter='*' --limit=0,100
mailcore users:get holger@example.com          # detail view
mailcore users:add new@example.com 4           # prompts for the password
mailcore users:new-password new@example.com    # prompts for the password
mailcore domains:list
mailcore mailboxplans:list
mailcore mailfilter:rbl-lookup 8.8.8.8         # exit 1 if listed
mailcore mailfilter:cdl-lookup 8.8.8.8         # exit 1 if listed; --email= is informational
mailcore datadump:fetch --output=dump.pgp

Configuration

Credentials are resolved in this order (first non-empty wins):

Environment variables MAILCORE_API_KEY / MAILCORE_BASE_URI
INI file at ~/.config/mailcore/config.ini (or $XDG_CONFIG_HOME/mailcore/config.ini)
Built-in default (base URI only)

; ~/.config/mailcore/config.ini   (see config.ini.example)
api_key         = "your-api-key"
base_uri        = "https://api.example.com"   ; optional
timeout         = 30   ; optional, seconds (0 disables); raise for large data dumps
connect_timeout = 10   ; optional, seconds (0 disables)

The timeouts also accept env overrides MAILCORE_TIMEOUT / MAILCORE_CONNECT_TIMEOUT.

mkdir -p ~/.config/mailcore
cp config.ini.example ~/.config/mailcore/config.ini
chmod 600 ~/.config/mailcore/config.ini   # keep the key private

Conventions:

Credentials come from the environment or the config file above, never CLI flags, so the key stays out of shell history and ps.
Passwords are read from a hidden prompt unless --password= is given, for the same reason.
Predicate commands set a non-zero exit code on the "negative" result (verify-password, rbl-lookup) so they compose in scripts.
List commands render tables; datadump:fetch streams raw bytes to stdout (or --output to a file).

Development & full docs

This package is developed in the Fjordmail/mailcore-sdk monorepo (this repository is a read-only subtree split). Issues and contributions belong there.

License

MIT — see LICENSE.

inboxcom / mailcore-cli

Maintainers

Package info

Statistics

Security