google styled doc
This commit is contained in:
@@ -1,6 +1,10 @@
|
||||
"""
|
||||
Message domain models for Mail Intake.
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
This module defines the **canonical, provider-agnostic representation**
|
||||
of an individual email message as used internally by the Mail Intake
|
||||
ingestion pipeline.
|
||||
@@ -19,37 +23,58 @@ class MailIntakeMessage:
|
||||
"""
|
||||
Canonical internal representation of a single email message.
|
||||
|
||||
This model represents a fully parsed and normalized email message.
|
||||
It is intentionally provider-agnostic and suitable for persistence,
|
||||
indexing, and downstream processing.
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
No provider-specific identifiers, payloads, or API semantics
|
||||
should appear in this model.
|
||||
- This model represents a fully parsed and normalized email message
|
||||
- It is intentionally provider-agnostic and suitable for persistence, indexing, and downstream processing
|
||||
|
||||
**Constraints:**
|
||||
|
||||
- No provider-specific identifiers, payloads, or API semantics should appear in this model
|
||||
"""
|
||||
|
||||
message_id: str
|
||||
"""Provider-specific message identifier."""
|
||||
"""
|
||||
Provider-specific message identifier.
|
||||
"""
|
||||
|
||||
thread_id: str
|
||||
"""Provider-specific thread identifier to which this message belongs."""
|
||||
"""
|
||||
Provider-specific thread identifier to which this message belongs.
|
||||
"""
|
||||
|
||||
timestamp: datetime
|
||||
"""Message timestamp as a timezone-naive UTC datetime."""
|
||||
"""
|
||||
Message timestamp as a timezone-naive UTC datetime.
|
||||
"""
|
||||
|
||||
from_email: str
|
||||
"""Sender email address."""
|
||||
"""
|
||||
Sender email address.
|
||||
"""
|
||||
|
||||
from_name: Optional[str]
|
||||
"""Optional human-readable sender name."""
|
||||
"""
|
||||
Optional human-readable sender name.
|
||||
"""
|
||||
|
||||
subject: str
|
||||
"""Raw subject line of the message."""
|
||||
"""
|
||||
Raw subject line of the message.
|
||||
"""
|
||||
|
||||
body_text: str
|
||||
"""Extracted plain-text body content of the message."""
|
||||
"""
|
||||
Extracted plain-text body content of the message.
|
||||
"""
|
||||
|
||||
snippet: str
|
||||
"""Short provider-supplied preview snippet of the message."""
|
||||
"""
|
||||
Short provider-supplied preview snippet of the message.
|
||||
"""
|
||||
|
||||
raw_headers: Dict[str, str]
|
||||
"""Normalized mapping of message headers (header name → value)."""
|
||||
"""
|
||||
Normalized mapping of message headers (header name → value).
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user