Mistake in the documentation of "check_smtp_tls_reporting" method in "smtp_tls_reporting.py"

domainaware / checkdmarc

A parser for SPF and DMARC DNS records

https://domainaware.github.io/checkdmarc

Apache License 2.0

244 stars 76 forks source link

Mistake in the documentation of "check_smtp_tls_reporting" method in "smtp_tls_reporting.py" #133

Open aharpour opened 3 months ago

aharpour commented 3 months ago

It seems that the documentation of the method "check_smtp_tls_reporting" in smtp_tls_reporting.py has been a copy from the method "check_mta_sts" in "mta_sts.py".

For example what check_smtp_tls_reporting returns have the following keys: "valid", "tags", and "warnings" but the documentation says:

id - The SIS-MTA DNS record ID
policy - The parsed MTA-STS policy
valid - True
warnings - A list of warnings