updated docs strings and added README.md
This commit is contained in:
@@ -1,34 +1,34 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Message parsing utilities for Mail Intake.
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
This package contains **provider-aware but adapter-agnostic parsing helpers**
|
||||
used to extract and normalize structured information from raw mail payloads.
|
||||
|
||||
Parsers in this package are responsible for:
|
||||
- Interpreting provider-native message structures
|
||||
- Extracting meaningful fields such as headers, body text, and subjects
|
||||
- Normalizing data into consistent internal representations
|
||||
|
||||
- Interpreting provider-native message structures.
|
||||
- Extracting meaningful fields such as headers, body text, and subjects.
|
||||
- Normalizing data into consistent internal representations.
|
||||
|
||||
This package does not:
|
||||
- Perform network or IO operations
|
||||
- Contain provider API logic
|
||||
- Construct domain models directly
|
||||
|
||||
- Perform network or IO operations.
|
||||
- Contain provider API logic.
|
||||
- Construct domain models directly.
|
||||
|
||||
Parsing functions are designed to be composable and are orchestrated by the
|
||||
ingestion layer.
|
||||
|
||||
---
|
||||
|
||||
## Public API
|
||||
# Public API
|
||||
|
||||
extract_body
|
||||
parse_headers
|
||||
extract_sender
|
||||
normalize_subject
|
||||
- `extract_body`
|
||||
- `parse_headers`
|
||||
- `extract_sender`
|
||||
- `normalize_subject`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user