updated docs strings and added README.md

This commit is contained in:
2026-03-08 17:59:53 +05:30
parent 0453fdd88a
commit c541577788
46 changed files with 863 additions and 681 deletions

View File

@@ -34,7 +34,8 @@ class MailIntakeAuthError(MailIntakeError):
Notes:
**Lifecycle:**
- Raised when authentication providers are unable to acquire, refresh, or persist valid credentials
- Raised when authentication providers are unable to acquire,
refresh, or persist valid credentials.
"""
@@ -45,7 +46,8 @@ class MailIntakeAdapterError(MailIntakeError):
Notes:
**Lifecycle:**
- Raised when a provider adapter encounters API errors, transport failures, or invalid provider responses
- Raised when a provider adapter encounters API errors, transport
failures, or invalid provider responses.
"""
@@ -56,5 +58,6 @@ class MailIntakeParsingError(MailIntakeError):
Notes:
**Lifecycle:**
- Raised when raw provider payloads cannot be interpreted or normalized into internal domain models
- Raised when raw provider payloads cannot be interpreted or
normalized into internal domain models.
"""