Skip to content

fix: update public API docs as per SemVer #4

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
ideepu merged 1 commit into from
Feb 26, 2026
Merged

fix: update public API docs as per SemVer #4

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
1 change: 0 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Domain checks: MX, SPF, DMARC, DKIM, SSL certificate.
- CLI with `--timeout`, skip flags per check, and `--compact` JSON.
- Library API: `validate_email_and_domain()`, `ValidationOptions`, `EmailDomainValidationResult`.
- Exceptions: `DomainPolicyError`.
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,7 @@ higher level business logic for final trust decisions.
### DKIM

Checks for DKIM records at `<selector>._domainkey.<domain>`. The validator
tries common selectors from [`DKIM_SELECTORS`](src/models.py#L79) and stops on
the first valid record found.
tries common DKIM selectors and stops on the first valid record found.

In the worst case, this performs one DNS TXT lookup per selector candidate
until a match is found (or candidates are exhausted).
Expand All @@ -141,8 +140,8 @@ hostname/chain trust validation.

## Result models

Results are returned as dataclasses (for example: `EmailDomainValidationResult`,
`SPFVerificationReport`). See `src/models.py` for the full model list.
The library returns `EmailDomainValidationResult`; its attributes and nested
report types are defined in `src/models.py`.

## Further validation

Expand Down