updated docs strings and added README.md
This commit is contained in:
@@ -1,19 +1,18 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Mail provider adapter implementations for Mail Intake.
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
This package contains **adapter-layer implementations** responsible for
|
||||
interfacing with external mail providers and exposing a normalized,
|
||||
provider-agnostic contract to the rest of the system.
|
||||
|
||||
Adapters in this package:
|
||||
- Implement the `MailIntakeAdapter` interface
|
||||
- Encapsulate all provider-specific APIs and semantics
|
||||
- Perform read-only access to mail data
|
||||
- Return provider-native payloads without interpretation
|
||||
|
||||
- Implement the `MailIntakeAdapter` interface.
|
||||
- Encapsulate all provider-specific APIs and semantics.
|
||||
- Perform read-only access to mail data.
|
||||
- Return provider-native payloads without interpretation.
|
||||
|
||||
Provider-specific logic **must not leak** outside of adapter implementations.
|
||||
All parsings, normalizations, and transformations must be handled by downstream
|
||||
@@ -21,10 +20,10 @@ components.
|
||||
|
||||
---
|
||||
|
||||
## Public API
|
||||
# Public API
|
||||
|
||||
MailIntakeAdapter
|
||||
MailIntakeGmailAdapter
|
||||
- `MailIntakeAdapter`
|
||||
- `MailIntakeGmailAdapter`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user