MailSchema for Python

Validate Mail Action Protocol documents and MailSchema Registry contributions with Draft 2020-12 JSON Schema checks.

Specification · Registry · Tools · Source

Install

pip install mailschema

Python 3.10 or newer is required.

Validate MAP documents

from mailschema import get_content_review_contract, validate_map_document, validate_content_review_request

validate_map_document(description)
validate_content_review_request(request)
contract = get_content_review_contract()

The CLI performs the same checks against local JSON files:

python -m mailschema check description.json --map
python -m mailschema check request.json --content-review

Work with Registry data

from mailschema import contribution_errors, get_contribution_schema, validate_contribution

errors = contribution_errors(candidate)
validate_contribution(candidate)  # Raises ValueError for invalid input.
schema = get_contribution_schema()

validate_record, record_errors and get_record_schema handle expanded Registry records. Pass --record to the CLI for the corresponding record format.

The package bundles the MAP 0.1 and Registry schemas plus the Content Review 0.1 and 0.2 request schemas and canonical type contracts. Unversioned Content Review helpers use 0.2; *_content_review_01_* helpers remain available for implementations pinned to 0.1. It uses the established jsonschema and referencing libraries for validation and performs no network requests.

Trust boundary

A valid document is structured input. Validation does not authenticate a service, grant authority, approve an action, resolve Registry history or establish product conformance. Implementations must apply their own endpoint trust, credentials, permissions and policy before executing a request.

The CLI reads one local file of at most 256 KiB and does not upload or modify it. Package versions and MAP profile versions advance independently. MIT licensed.