Skip to content

feat: add --report-body-file to customize aggregate report mail body #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thegushi merged 1 commit into from
Jun 27, 2026
Merged

feat: add --report-body-file to customize aggregate report mail body #437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions reports/opendmarc-reports.8.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,24 @@ Normally this would be done to prevent reports from being sent too close
together. Implied by
.IR --test .
.TP
.I --report-body-file=file
Replaces the default plain-text body of aggregate report e-mail messages
with the contents of
.IR file ,
read once at startup. The tokens
.B %DOMAIN%
and
.B %DATE%
are substituted, if present, with the reporting domain and the message's
.I Date:
header value, respectively. If not specified, the default body is
.RS
.nf
This is a DMARC aggregate report for <domain>
generated at <timestamp>
.fi
.RE
.TP
.I --report-contact=addr
Specifies the contact address written into the
.I <email>
Expand Down
27 changes: 25 additions & 2 deletions reports/opendmarc-reports.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,8 @@ my $dbscheme = $def_dbscheme;
my $repdom = hostdomain();
my $repemail = "postmaster@" . $repdom;
my $repcontact;
my $repbodyfile;
my $repbodytemplate;

my $smtp_server = '127.0.0.1';
my $smtp_port = 25;
Expand Down Expand Up @@ -393,6 +395,8 @@ sub usage
print STDERR "\t--nodomain=name omit a report for named domain\n";
print STDERR "\t--noupdate don't record report transmission\n";
print STDERR "\t--report-bcc bcc address for aggregate reports\n";
print STDERR "\t--report-body-file=file custom plain-text body for aggregate\n";
print STDERR "\t reports (%DOMAIN%/%DATE% tokens substituted)\n";
print STDERR "\t--report-contact contact address for report metadata (default: --report-email)\n";
print STDERR "\t--report-email envelope/From address for outgoing reports [$repemail]\n";
print STDERR "\t--report-org reporting organization [$repdom]\n";
Expand Down Expand Up @@ -500,6 +504,7 @@ my $opt_retval = &Getopt::Long::GetOptions ('archive-dir=s' => \$archive_dir,
'n|test' => \$testmode,
'nodomain=s' => \@skipdomains,
'report-bcc=s' => \$repbcc,
'report-body-file=s' => \$repbodyfile,
'report-contact=s' => \$repcontact,
'report-email=s' => \$repemail,
'report-org=s' => \$repdom,
Expand Down Expand Up @@ -644,6 +649,14 @@ if (defined($noreports_file))
close($nrf);
}

if (defined($repbodyfile))
{
open(my $rbf, '<', $repbodyfile)
or die "$progname: can't open report body file $repbodyfile: $!\n";
$repbodytemplate = do { local $/; <$rbf> };
close($rbf);
}

# Test mode requested, don't update last sent and keep xml files
$doupdate = ($testmode == 1) ? 0 : $doupdate;
$keepfiles = ($testmode == 1) ? 1 : $keepfiles;
Expand Down Expand Up @@ -1687,8 +1700,18 @@ foreach (@$domainset)
$mailout .= "--$boundary\n";
$mailout .= "Content-Type: text/plain;\n";
$mailout .= "\n";
$mailout .= "This is a DMARC aggregate report for $domain\n";
$mailout .= "generated at " . localtime() . "\n";
if (defined($repbodytemplate))
{
my $body = $repbodytemplate;
$body =~ s/%DOMAIN%/$domain/g;
$body =~ s/%DATE%/$datestr/g;
$mailout .= $body;
}
else
{
$mailout .= "This is a DMARC aggregate report for $domain\n";
$mailout .= "generated at " . localtime() . "\n";
}
$mailout .= "\n";
$mailout .= "--$boundary\n";
$mailout .= "Content-Type: application/gzip\n";
Expand Down
Loading