cbowofrivia/dmarc-record-builder

A lean package that makes creating DMARC records user friendly

2.0.0 2024-04-20 07:22 UTC

Requires

• php: ^8.2
• illuminate/collections: ^11.4
• webmozart/assert: ^1.10

Requires (Dev)

• laravel/pint: ^1.15
• pestphp/pest: ^2
• symfony/var-dumper: ^7.0

MIT

• Charles Bowen

• dmarc
• cbowofrivia
• dmarc-record-builder

README

Installation

You can install the package via composer:

composer require cbowofrivia/dmarc-record-builder

Usage

$record = new DmarcRecord();

$record->policy('none')
    ->subdomainPolicy('none')
    ->pct(100)
    ->rua('mailto:[e-mail]')
    ->ruf('mailto:[e-mail]')
    ->adkim('relaxed')
    ->aspf('relaxed')
    ->reporting('any')
    ->interval(604800);

$record = (string) $record;
// v=DMARC1; p=none; sp=none; pct=100; rua=mailto:[e-mail]; ruf=mailto:[e-mail]; fo=1; adkim=r; aspf=r; ri=604800;

You can also build the record in the constructor

$record = new DmarcRecord(
    version: 'DMARC1'
    policy: 'none'
    subdomain_policy: 'none'
    pct: 100
    rua: 'mailto:[e-mail]'
    ruf: 'mailto:[e-mail]'
    adkim: 'relaxed'
    aspf: 'relaxed' 
    reporting: 'any'
    interval: 604800
);

$record = (string) $record;
// v=DMARC1; p=none; sp=none; pct=100; rua=mailto:[e-mail]; ruf=mailto:[e-mail]; fo=1; adkim=r; aspf=r; ri=604800;

Testing

composer test

If you're using WSL2 + Docker, you can install and test with the provided docker-compose.yaml file.

docker-compose run --rm php composer install && \
docker-compose run --rm php composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Charles Bowen
• All Contributors

License

The MIT License (MIT). Please see License File for more information.