bird email tools analyze-dmarc-report

Usage

Code example

bird email tools analyze-dmarc-report <report-xml> [flags]

Analyze a DMARC aggregate (RUA) report and get back totals, a per-source-IP breakdown, and plain-language findings. These are the XML reports mailbox providers email to the address in your DMARC rua= tag, supplied in report_xml. The tool reports the overall pass rate, which sources are passing or failing SPF and DKIM alignment (and which domains a failing source is sending as, usually a forwarder), and flags the things worth acting on. It answers what a hard-to-read DMARC report says and which of your senders are failing. Offline: nothing is looked up or sent. Public: no authentication required.

Build the request from the <report_xml> argument, a JSON AnalyzeDmarcReportRequest body via --body-file ("-" reads stdin), or both — an inline value overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example

# print the body shape (no credentials needed)
bird email tools analyze-dmarc-report --example

# the body it prints:

Code example

{
  "report_xml": "<feedback>\n  <report_metadata>\n    <org_name>example.net</org_name>\n    <report_id>14297523</report_id>\n  </report_metadata>\n  <policy_published>\n    <domain>example.com</domain>\n    <p>none</p>\n  </policy_published>\n  <record>\n    <row>\n      <source_ip>203.0.113.10</source_ip>\n      <count>42</count>\n      <policy_evaluated><disposition>none</disposition><dkim>pass</dkim><spf>pass</spf></policy_evaluated>\n    </row>\n  </record>\n</feedback>\n"
}

Options

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--response-schema	Print the fields this command returns, then exit

Name	Description
bird email tools analyze-headers	Analyze raw email headers
bird email tools audit	Audit a domain's email authentication
bird email tools split-dns-record	Split a long DNS TXT value into 255-octet chunks
bird email tools validate-bimi	Validate a BIMI record
bird email tools validate-dmarc	Validate a DMARC record