updated docs strings and added README.md
This commit is contained in:
@@ -1,17 +1,16 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Gmail adapter implementation for Mail Intake.
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
This module provides a **Gmail-specific implementation** of the
|
||||
`MailIntakeAdapter` contract.
|
||||
|
||||
It is the only place in the codebase where:
|
||||
- `googleapiclient` is imported
|
||||
- Gmail REST API semantics are known
|
||||
- Low-level `.execute()` calls are made
|
||||
|
||||
- `googleapiclient` is imported.
|
||||
- Gmail REST API semantics are known.
|
||||
- Low-level `.execute()` calls are made.
|
||||
|
||||
All Gmail-specific behavior must be strictly contained within this module.
|
||||
"""
|
||||
@@ -37,15 +36,15 @@ class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- This class is the ONLY place where googleapiclient is imported
|
||||
- Gmail REST semantics are known
|
||||
- .execute() is called
|
||||
- This class is the ONLY place where `googleapiclient` is imported.
|
||||
- Gmail REST semantics are known.
|
||||
- `.execute()` is called.
|
||||
|
||||
**Constraints:**
|
||||
|
||||
- Must remain thin and imperative
|
||||
- Must not perform parsing or interpretation
|
||||
- Must not expose Gmail-specific types beyond this class
|
||||
|
||||
- Must remain thin and imperative.
|
||||
- Must not perform parsing or interpretation.
|
||||
- Must not expose Gmail-specific types beyond this class.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
|
||||
Reference in New Issue
Block a user