opendmarc-reports(8)

💖 opendmarc-reports(8) — the OpenDMARC aggregate report girlie 💖

okay bestie, welcome to the opendmarc-reports page, straight outta the System Manager's Manual ✨ this is the tool that pulls your DMARC data out of the database and turns it into aggregate reports that actually go places. it's giving backstage-pass energy. let's get into it 🎀

✨ NAME ✨

opendmarc-reports — the OpenDMARC aggregate report generation tool 🦋

🌸 SYNOPSIS 🌸

opendmarc-reports [options]

that's it. that's the whole vibe. you hand it some options and it does the thing 💅

💜 DESCRIPTION 💜

so, opendmarc-reports reaches into an OpenDMARC database and generates periodic aggregate reports from what it finds. no cap.

and where does that data come from? bestie, the database gets populated by a running opendmarc-import(8) working on a message history file — and that file is generated by an opendmarc(8) filter as messages arrive and get processed. it's a whole pipeline, and honestly? iconic. 🌈

this also covers the collection of reporting URIs, which this script uses to make reports available to the people who request them. so it's not just generating — it's delivering. main character behavior fr fr 👑

💅 OPTIONS 💅

• --day — generates reports on day boundaries. this one overrides whatever --interval is set to (more on that below). periodt.
• --dbhost=hostname — tells it which hostname the SQL server is running on. defaults to the value of the environment variable OPENDMARC_DBHOST, or "localhost" if that env var isn't set. 🏠
• --dbname=name — the SQL database name you want accessed. defaults to the environment variable OPENDMARC_DB, or "opendmarc" if it's not set. 🗂️
• --dbpasswd=password — the password for the SQL database. defaults to the environment variable OPENDMARC_PASSWORD, or "opendmarc" if that's not set. 🔐 (yes bestie, keep it secret, keep it safe)
• --dbport=port — which TCP port the SQL server is expected to be listening on. defaults to the environment variable OPENDMARC_PORT, or 3306 if it's not set. 🔌
• --dbuser=user — the SQL user used to access the database. defaults to the environment variable OPENDMARC_USER, or "opendmarc" if it's not set. 🙋
• --domain=name — generates a report (if one is due) for the named domain, instead of checking all of them. one domain only, no scrolling. 🎯
• --help — prints a help message and terminates. your lil emergency exit 🚪
• --interval=secs — only generates reports for hosts that haven't had a report generated in at least the last secs seconds. patience is a virtue or whatever ⏳
• --nodomain=name — skips generating a report for the named domain. you can specify this multiple times to skip multiple reporting domains. the block list era 🙈
• --noupdate — suppresses marking the time of the transmission of the report in the database. normally that marking would happen, specifically to prevent reports from being sent too close together. so like, don't do this unless you know why. 💀
• --report-email=addr — generates reports using the specified address, which gets used both in the report content and in the SMTP transaction. the default is "postmaster@HOSTNAME", where HOSTNAME is replaced by the hostname of the host generating the report. 📧
• --report-org=domain — generates reports using the specified domain name as the organization responsible for the report. this is used to create the archive filename and it's included in the report content too. default is the hostname of the host generating the report. 🏷️
• --smtp-host=host — makes reports get sent by transmitting them via SMTP to the named host, which can be an IP address or a hostname. default is "127.0.0.1". 📮
• --smtp-port=port — makes reports get sent by transmitting them via SMTP to the specified port. default is 25. 🔢
• --utc — instructs the database to switch to the UTC timezone when generating output. otherwise, the database default gets used. 🌍
• --verbose — increases the amount of verbosity written to standard output. chatty era 🗣️
• --version — prints the version number and exits. 🫶

⭐ VERSION ⭐

this man page covers the version of opendmarc-reports that shipped with version 1.4.2 of OpenDMARC. so if you're on something else, vibe check accordingly 💫

🎀 COPYRIGHT 🎀

Copyright (c) 2012, 2014, 2015, The Trusted Domain Project. All rights reserved.

🦋 SEE ALSO 🦋

• opendmarc(8)
• opendmarc.conf(5)
• opendmarc-import(8)

okay that's the whole page bestie, you ate it up 💖 this one comes to you from The Trusted Domain Project, and it's the opendmarc-reports(8) page itself — go forth and generate those reports, you've got this 👑✨🌸