oracular (3) Mail::DMARC::Report::Aggregate.3pm.gz
NAME
Mail::DMARC::Report::Aggregate - aggregate report object
VERSION
version 1.20240314
DESCRIPTION
This class is used as the canonization of an aggregate report.
When reports are received, the XML is parsed into an Aggregate object, which then gets passed to the
Report::Store and saved. When sending DMARC reports, data is extracted from the Store as an Aggregate
object, exported as XML, and sent.
2013 Draft Description
AGGREGATE REPORTS
The report SHOULD include the following data:
o Enough information for the report consumer to re-calculate DMARC
disposition based on the published policy, message disposition, and
SPF, DKIM, and identifier alignment results. {R12}
o Data for each sender subdomain separately from mail from the
sender's organizational domain, even if no subdomain policy is
applied. {R13}
o Sending and receiving domains {R17}
o The policy requested by the Domain Owner and the policy actually
applied (if different) {R18}
o The number of successful authentications {R19}
o The counts of messages based on all messages received even if
their delivery is ultimately blocked by other filtering agents {R20}
Aggregate reports are most useful when they all cover a common time period. By contrast, correlation of
these reports from multiple generators when they cover incongruous time periods is difficult or
impossible. Report generators SHOULD, wherever possible, adhere to hour boundaries for the reporting
period they are using. For example, starting a per-day report at 00:00; starting per-hour reports at
00:00, 01:00, 02:00; et cetera. Report Generators using a 24-hour report period are strongly encouraged
to begin that period at 00:00 UTC, regardless of local timezone or time of report production, in order to
facilitate correlation.
Report Structure
This is a translation of the XML report format in the 2013 Draft, converted to perl data structures.
feedback => {
version => 1.0, # decimal
report_metadata => { # info about DMARC reporter
report_id => string
org_name => 'Art Farm',
email => 'no-reply@theartfarm.com',
extra_contact_info => string # min 0
date_range => {
begin => epoch time,
end => epoch time,
},
error => string, # min 0, max unbounded
},
policy_published => {
domain => string
adkim => r, s
aspf => r, s
p => none, quarantine, reject
sp => none, quarantine, reject
pct => integer
fo => string
},
record => [
{ row => {
source_ip => # IPAddress
count => # integer
policy_evaluated => { # min=1
disposition => # none, quarantine, reject
dkim => # pass, fail
spf => # pass, fail
reason => [ # min 0, max unbounded
{ type => # forwarded sampled_out, trusted_forwarder, mailing_list, local_policy, other
comment => # string, min 0
},
],
}
},
identifiers => {
envelope_to min=0
envelope_from min=1
header_from min=1
},
auth_results => {
spf => [ # min 1, max unbounded
{ domain => # min 1
scope => # min 1, helo, mfrom
result => # min 1, none neutral pass fail softfail temperror permerror
}
] # ( unknown -> temperror, error -> permerror )
dkim => [ # min 0, max unbounded
{ domain => , # min 1, the d= parameter in the signature
selector => , # min 0, string
result => , # none pass fail policy neutral temperror permerror
human_result => # min 0, string
},
],
},
]
},
};
AUTHORS
• Matt Simerson <msimerson@cpan.org> • Davide Migliavacca <shari@cpan.org> • Marc Bradshaw <marc@marcbradshaw.net>
COPYRIGHT AND LICENSE
This software is copyright (c) 2024 by Matt Simerson.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5
programming language system itself.