Skip to the documentation
CLI

openemail tools

Every command in this namespace, with its arguments, flags and examples.

Commands

Checks of the public mail records of any domain, the free tools on the OpenEmail website: its DMARC policy, its BIMI logo and a deliverability report across MX, SPF, DKIM, DMARC and BIMI. They need no scope.

Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags

openemail tools check-dmarc

Check a domain's DMARC policy

Needs a sign-in

Usage

openemail tools check-dmarc <domain> [flags]

Reads the domain's DMARC record from public DNS, or the record of the organisational domain it inherits from, and says how strict it is and what is wrong with it, the DMARC checker on the OpenEmail website. stage is missing, invalid, monitor for p=none, quarantine or reject, and issues lists the problems written to be shown to a person.

Arguments

<domain>Required

The domain to check, such as acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.

Examples

openemail tools check-dmarc acme.com
Print the raw JSON
openemail tools check-dmarc acme.com --json

Also available in

API
GET /tools/dmarc
SDK
tools.checkDmarc()

openemail tools check-bimi

Check a domain's BIMI logo

Needs a sign-in

Usage

openemail tools check-bimi <domain> [flags]

Reads the domain's BIMI record, fetches the logo it names and checks the DMARC policy beside it, since inboxes draw a logo only at p=quarantine or p=reject, the BIMI checker on the OpenEmail website. status is present, partial when the record is there but something stops inboxes showing the logo, absent or invalid, and issues says why.

Arguments

<domain>Required

The domain to check, such as acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.

Examples

openemail tools check-bimi acme.com
Print the raw JSON
openemail tools check-bimi acme.com --json

Also available in

API
GET /tools/bimi
SDK
tools.checkBimi()

openemail tools check-deliverability

Check a domain's deliverability

Needs a sign-in

Usage

openemail tools check-deliverability <domain> [flags]

Checks the records a receiving mailbox reads before it trusts mail from the domain, the deliverability checker on the OpenEmail website: MX, SPF, DKIM at the selectors its mail provider uses, DMARC and BIMI. Each check says pass, warn, fail or absent with a verdict and notes, and score weighs them into 0 to 100, graded A to F.

Arguments

<domain>Required

The domain to check, such as acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.

Examples

openemail tools check-deliverability acme.com
Print the raw JSON
openemail tools check-deliverability acme.com --json

Also available in

API
GET /tools/deliverability
SDK
tools.checkDeliverability()