avvertix / dmarc-report-parser
Parse DMARC xml reports
Requires
- php: ^8.3
- saloonphp/xml-wrangler: ^1.3
- symfony/mime: ^7.0.3
Requires (Dev)
- laravel/pint: ^1.0
- pestphp/pest: ^3.0
- symfony/var-dumper: ^7.2
This package is auto-updated.
Last update: 2025-03-13 07:56:58 UTC
README
DMARC Report Parser is designed to simplify the analysis of DMARC (Domain-based Message Authentication, Reporting & Conformance) reports:
- Parse the XML-based report into fully typed classes
- Read reports from GZip files without decompressing first (coming soon)
Installation
You can install the package via composer:
composer require avvertix/dmarc-report-parser
Require PHP 8.3 with xsl
and sodium
extensions.
Usage
It is possible to parse reports from XML files or strings. The output is fully typed instance of DmarcReport
.
from file
$dmarc = new Avvertix\DmarcReportParser\DmarcReportParser(); /** * @var Avvertix\DmarcReportParser\Data\DmarcReport */ $report = $dmarc->fromFile('path/to/report.xml');
from string
$dmarc = new Avvertix\DmarcReportParser\DmarcReportParser(); $xml = <<<'DMARC' <?xml version="1.0"?> <feedback xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <version>1.0</version> <!-- content omitted for brevity --> </feedback> DMARC; /** * @var Avvertix\DmarcReportParser\Data\DmarcReport */ $report = $dmarc->fromString($xml);
DmarcReport class
The DmarcReport
class represent the report in a fully typed manner.
A few differences with respect to the spec:
- Report generator metadata are directly accessible from the
DmarcReport
class and not encapsulated in an object - Records are exposed using the
records
(array) property - In AuthResult both dkim and spf properties are represented as arrays
- In general when the spec report an element to be available multiple times we represent it as an array property
Testing
DMARC Report Parser is covered in unit test. The PestPHP framework is used. To run the whole test suite execute the test
script.
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.