Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 101e49d3c8 | |||
| 371b74806f | |||
| c541577788 | |||
| 0453fdd88a | |||
| 9f9e472ada | |||
| 9f37af5761 | |||
| 346cc5f6fb | |||
| f7f9744e47 | |||
| 9d1635c043 | |||
| 32c2c07aa2 | |||
| d0978cea99 | |||
| 93b3718320 | |||
| 6a4aece659 | |||
| 3636e6edc8 |
60
.drone.yml
60
.drone.yml
@@ -23,20 +23,50 @@ steps:
|
||||
commands:
|
||||
- PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | head -1 | cut -d'"' -f2)
|
||||
- VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | cut -d'"' -f2)
|
||||
- echo "🔍 Checking if $PACKAGE_NAME==$VERSION exists on $PIP_REPO_URL ..."
|
||||
- |
|
||||
if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" "$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -q "$VERSION"; then
|
||||
echo "✅ $PACKAGE_NAME==$VERSION already exists — skipping build."
|
||||
if [ "$DRONE_TAG" != "$VERSION" ]; then
|
||||
echo "Tag '$DRONE_TAG' does not match pyproject version '$VERSION'; refusing to publish."
|
||||
exit 1
|
||||
fi
|
||||
- echo "Checking if $PACKAGE_NAME==$VERSION exists on $PIP_REPO_URL ..."
|
||||
- |
|
||||
if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" "$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -qE "${PACKAGE_NAME}-${VERSION}(-|\.tar\.gz|\.whl)"; then
|
||||
echo "$PACKAGE_NAME==$VERSION already exists; skipping build."
|
||||
exit 78
|
||||
else
|
||||
echo "🆕 New version detected: $PACKAGE_NAME==$VERSION"
|
||||
echo "New version detected: $PACKAGE_NAME==$VERSION"
|
||||
fi
|
||||
|
||||
- name: quality-gate
|
||||
image: python:3.13-slim
|
||||
environment:
|
||||
PIP_REPO_URL:
|
||||
from_secret: PIP_REPO_URL
|
||||
PIP_USERNAME:
|
||||
from_secret: PIP_USERNAME
|
||||
PIP_PASSWORD:
|
||||
from_secret: PIP_PASSWORD
|
||||
commands:
|
||||
- pip install --upgrade pip build
|
||||
- |
|
||||
if [ -z "$PIP_REPO_URL" ] || [ -z "$PIP_USERNAME" ] || [ -z "$PIP_PASSWORD" ]; then
|
||||
echo "PIP_REPO_URL / PIP_USERNAME / PIP_PASSWORD are not set" >&2
|
||||
exit 1
|
||||
fi
|
||||
- AUTH_URL="https://$PIP_USERNAME:$PIP_PASSWORD@$(echo "$PIP_REPO_URL" | sed -E 's|^[a-zA-Z]+://||; s|/*$||')/simple"
|
||||
- pip install --index-url "$AUTH_URL" --extra-index-url https://pypi.org/simple/ -U ".[dev]" "pydoclint>=0.9.1"
|
||||
- echo "Running quality gate..."
|
||||
- python -m black --check .
|
||||
- python -m ruff check .
|
||||
- python -m mypy
|
||||
- pydoclint .
|
||||
- python -m pytest
|
||||
|
||||
- name: build-package
|
||||
image: python:3.13-slim
|
||||
commands:
|
||||
- pip install --upgrade pip build
|
||||
- echo "📦 Building Python package..."
|
||||
- echo "Building Python package..."
|
||||
- python -m build
|
||||
- ls -l dist
|
||||
|
||||
@@ -51,7 +81,7 @@ steps:
|
||||
from_secret: PIP_PASSWORD
|
||||
commands:
|
||||
- pip install --upgrade twine
|
||||
- echo "🚀 Uploading to private PyPI at $PIP_REPO_URL ..."
|
||||
- echo "Uploading to private PyPI at $PIP_REPO_URL ..."
|
||||
- |
|
||||
twine upload \
|
||||
--repository-url "$PIP_REPO_URL" \
|
||||
@@ -98,25 +128,31 @@ steps:
|
||||
set -e
|
||||
|
||||
PACKAGE_NAME=$(grep -E '^name\s*=' pyproject.toml | cut -d'"' -f2)
|
||||
echo "📦 Package: $PACKAGE_NAME"
|
||||
echo "Package: $PACKAGE_NAME"
|
||||
|
||||
for TAG in $(git tag --sort=version:refname); do
|
||||
VERSION="$TAG"
|
||||
echo "🔁 Version: $VERSION"
|
||||
echo "Version: $VERSION"
|
||||
|
||||
if curl -fsSL -u "$PIP_USERNAME:$PIP_PASSWORD" \
|
||||
"$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -q "$VERSION"; then
|
||||
echo "⏭️ Exists, skipping"
|
||||
"$PIP_REPO_URL/simple/$PACKAGE_NAME/" | grep -qE "${PACKAGE_NAME}-${VERSION}(-|\.tar\.gz|\.whl)"; then
|
||||
echo "Exists, skipping"
|
||||
continue
|
||||
fi
|
||||
|
||||
git checkout --force "$TAG"
|
||||
|
||||
echo "🏗️ Building $VERSION"
|
||||
TAG_VERSION=$(grep -E '^version\s*=' pyproject.toml | head -1 | cut -d'"' -f2)
|
||||
if [ "$TAG" != "$TAG_VERSION" ]; then
|
||||
echo "Tag $TAG != pyproject version $TAG_VERSION at that commit; skipping"
|
||||
continue
|
||||
fi
|
||||
|
||||
echo "Building $VERSION"
|
||||
rm -rf dist
|
||||
python -m build
|
||||
|
||||
echo "⬆️ Uploading $VERSION"
|
||||
echo "Uploading $VERSION"
|
||||
twine upload \
|
||||
--repository-url "$PIP_REPO_URL" \
|
||||
-u "$PIP_USERNAME" \
|
||||
|
||||
7
.gitignore
vendored
7
.gitignore
vendored
@@ -25,10 +25,17 @@ env/
|
||||
htmlcov/
|
||||
coverage.xml
|
||||
|
||||
# Lint / type checking
|
||||
.mypy_cache/
|
||||
.ruff_cache/
|
||||
|
||||
# Environment variables
|
||||
.env
|
||||
.env.local
|
||||
|
||||
# Docs build artifacts
|
||||
site
|
||||
|
||||
# OS
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
33
CHANGELOG.md
Normal file
33
CHANGELOG.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.0.3] - 2026-10-17
|
||||
|
||||
### Added
|
||||
- `py.typed` marker for PEP 561 type information.
|
||||
- Hand-written wiki, plus doc-forge-generated API reference under `docs/lib`
|
||||
and MCP bundle under `docs/mcp` (per-kind MkDocs configs).
|
||||
- MIT `LICENSE`.
|
||||
|
||||
### Changed
|
||||
- Adopted the standard Type A PyPI CI pipeline: a `tag == version` guard and a
|
||||
quality gate (black, ruff, mypy, pydoclint, pytest).
|
||||
- Standardized `pyproject.toml` (canonical packaging, lint tool config, extras)
|
||||
with a shared Google-style `[tool.pydoclint]` configuration.
|
||||
- Google-style (GSDFC) docstrings across the public API; legacy typing
|
||||
modernised to match signatures.
|
||||
- `fetch_emails.py` debug script excluded from black/ruff scans.
|
||||
|
||||
### Fixed
|
||||
- Regression test for immutable config models raises `AssertionError` instead
|
||||
of a bare `assert False`.
|
||||
- Stub fixes for typed API surfaces.
|
||||
|
||||
[Unreleased]: https://git.aetoskia.com/aetos/mail-intake/compare/0.0.3...HEAD
|
||||
[0.0.3]: https://git.aetoskia.com/aetos/mail-intake/compare/0.0.2...0.0.3
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Aetoskia Platform
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
138
README.md
Normal file
138
README.md
Normal file
@@ -0,0 +1,138 @@
|
||||
# mail_intake
|
||||
|
||||
# Summary
|
||||
|
||||
Mail Intake — provider-agnostic, read-only email ingestion framework.
|
||||
|
||||
Mail Intake is a **contract-first library** designed to ingest, parse, and
|
||||
normalize email data from external providers (such as Gmail) into clean,
|
||||
provider-agnostic domain models.
|
||||
|
||||
The library is intentionally structured around clear layers, each exposed
|
||||
as a first-class module at the package root:
|
||||
|
||||
- `adapters`: Provider-specific access (e.g., Gmail).
|
||||
- `auth`: Authentication providers and credential lifecycle management.
|
||||
- `credentials`: Credential persistence abstractions and implementations.
|
||||
- `parsers`: Extraction and normalization of message content.
|
||||
- `ingestion`: Orchestration and high-level ingestion workflows.
|
||||
- `models`: Canonical, provider-agnostic data representations.
|
||||
- `config`: Explicit global configuration.
|
||||
- `exceptions`: Library-defined error hierarchy.
|
||||
|
||||
The package root acts as a **namespace**, not a facade. Consumers are
|
||||
expected to import functionality explicitly from the appropriate module.
|
||||
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
Install using pip:
|
||||
|
||||
```bash
|
||||
pip install mail-intake
|
||||
```
|
||||
|
||||
Or with Poetry:
|
||||
|
||||
```bash
|
||||
poetry add mail-intake
|
||||
```
|
||||
|
||||
Mail Intake is pure Python and has no runtime dependencies beyond those
|
||||
required by the selected provider (for example, Google APIs for Gmail).
|
||||
|
||||
---
|
||||
|
||||
# Quick Start
|
||||
|
||||
Minimal Gmail ingestion example (local development):
|
||||
|
||||
```python
|
||||
from mail_intake.ingestion import MailIntakeReader
|
||||
from mail_intake.adapters import MailIntakeGmailAdapter
|
||||
from mail_intake.auth import MailIntakeGoogleAuth
|
||||
from mail_intake.credentials import PickleCredentialStore
|
||||
|
||||
store = PickleCredentialStore(path="token.pickle")
|
||||
|
||||
auth = MailIntakeGoogleAuth(
|
||||
credentials_path="credentials.json",
|
||||
store=store,
|
||||
scopes=["https://www.googleapis.com/auth/gmail.readonly"],
|
||||
)
|
||||
|
||||
adapter = MailIntakeGmailAdapter(auth_provider=auth)
|
||||
reader = MailIntakeReader(adapter)
|
||||
|
||||
for message in reader.iter_messages("from:recruiter@example.com"):
|
||||
print(message.subject, message.from_email)
|
||||
```
|
||||
|
||||
Iterating over threads:
|
||||
|
||||
```python
|
||||
for thread in reader.iter_threads("subject:Interview"):
|
||||
print(thread.normalized_subject, len(thread.messages))
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
Mail Intake is designed to be extensible via **public contracts** exposed
|
||||
through its modules:
|
||||
|
||||
- Users MAY implement their own mail adapters by subclassing
|
||||
`adapters.MailIntakeAdapter`.
|
||||
- Users MAY implement their own authentication providers by subclassing
|
||||
`auth.MailIntakeAuthProvider[T]`.
|
||||
- Users MAY implement their own credential persistence layers by implementing
|
||||
`credentials.CredentialStore[T]`.
|
||||
|
||||
Users SHOULD NOT subclass built-in adapter implementations. Built-in
|
||||
adapters (such as Gmail) are reference implementations and may change
|
||||
internally without notice.
|
||||
|
||||
**Design Guarantees:**
|
||||
|
||||
- Read-only access: no mutation of provider state.
|
||||
- Provider-agnostic domain models.
|
||||
- Explicit configuration and dependency injection.
|
||||
- No implicit global state or environment reads.
|
||||
- Deterministic, testable behavior.
|
||||
- Distributed-safe authentication design.
|
||||
|
||||
Mail Intake favors correctness, clarity, and explicitness over convenience
|
||||
shortcuts.
|
||||
|
||||
**Core Philosophy:**
|
||||
|
||||
`Mail Intake` is built as a **contract-first ingestion pipeline**:
|
||||
|
||||
1. **Layered Decoupling**: Adapters handle transport, Parsers handle format
|
||||
normalization, and Ingestion orchestrates.
|
||||
2. **Provider Agnosticism**: Domain models and core logic never depend on
|
||||
provider-specific (e.g., Gmail) API internals.
|
||||
3. **Stateless Workflows**: The library functions as a read-only pipe, ensuring
|
||||
side-effect-free ingestion.
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
The supported public API consists of the following top-level modules:
|
||||
|
||||
- `mail_intake.ingestion`
|
||||
- `mail_intake.adapters`
|
||||
- `mail_intake.auth`
|
||||
- `mail_intake.credentials`
|
||||
- `mail_intake.parsers`
|
||||
- `mail_intake.models`
|
||||
- `mail_intake.config`
|
||||
- `mail_intake.exceptions`
|
||||
|
||||
Classes and functions should be imported explicitly from these modules.
|
||||
No individual symbols are re-exported at the package root.
|
||||
|
||||
---
|
||||
32
docforge.nav.yml
Normal file
32
docforge.nav.yml
Normal file
@@ -0,0 +1,32 @@
|
||||
home: lib/index.md
|
||||
groups:
|
||||
Core API:
|
||||
- lib/ingestion/index.md
|
||||
- lib/ingestion/reader.md
|
||||
Domain Models:
|
||||
- lib/models/index.md
|
||||
- lib/models/message.md
|
||||
- lib/models/thread.md
|
||||
Provider Adapters:
|
||||
- lib/adapters/index.md
|
||||
- lib/adapters/base.md
|
||||
- lib/adapters/gmail.md
|
||||
Authentication & Storage:
|
||||
- lib/auth/index.md
|
||||
- lib/auth/base.md
|
||||
- lib/auth/google.md
|
||||
- lib/credentials/index.md
|
||||
- lib/credentials/store.md
|
||||
- lib/credentials/pickle.md
|
||||
- lib/credentials/redis.md
|
||||
Normalization & Parsing:
|
||||
- lib/parsers/index.md
|
||||
- lib/parsers/body.md
|
||||
- lib/parsers/headers.md
|
||||
- lib/parsers/subject.md
|
||||
Configuration & Errors:
|
||||
- lib/config.md
|
||||
- lib/exceptions.md
|
||||
icon:
|
||||
logo: material/inbox
|
||||
repo: fontawesome/brands/github
|
||||
3
docs/lib/credentials/index.md
Normal file
3
docs/lib/credentials/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Credentials
|
||||
|
||||
::: mail_intake.credentials
|
||||
3
docs/lib/credentials/pickle.md
Normal file
3
docs/lib/credentials/pickle.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Pickle
|
||||
|
||||
::: mail_intake.credentials.pickle
|
||||
3
docs/lib/credentials/redis.md
Normal file
3
docs/lib/credentials/redis.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Redis
|
||||
|
||||
::: mail_intake.credentials.redis
|
||||
3
docs/lib/credentials/store.md
Normal file
3
docs/lib/credentials/store.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Store
|
||||
|
||||
::: mail_intake.credentials.store
|
||||
@@ -1,3 +1,3 @@
|
||||
# Mail Intake
|
||||
# mail_intake
|
||||
|
||||
::: mail_intake
|
||||
6
docs/mcp/index.json
Normal file
6
docs/mcp/index.json
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"project": "Mail Intake",
|
||||
"type": "docforge-model",
|
||||
"modules_count": 22,
|
||||
"source": "docforge"
|
||||
}
|
||||
39
docs/mcp/modules/mail_intake.adapters.base.json
Normal file
39
docs/mcp/modules/mail_intake.adapters.base.json
Normal file
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"module": "mail_intake.adapters.base",
|
||||
"content": {
|
||||
"path": "mail_intake.adapters.base",
|
||||
"docstring": "# Summary\n\nMail provider adapter contracts for Mail Intake.\n\nThis module defines the **provider-agnostic adapter interface** used for\nread-only mail ingestion.\n\nAdapters encapsulate all provider-specific access logic and expose a\nminimal, normalized contract to the rest of the system. No provider-specific\ntypes or semantics should leak beyond implementations of this interface.",
|
||||
"objects": {
|
||||
"MailIntakeAdapter": {
|
||||
"name": "MailIntakeAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.base.MailIntakeAdapter",
|
||||
"signature": null,
|
||||
"docstring": "Base adapter interface for mail providers.\n\nNotes:\n **Guarantees:**\n\n - Discover messages matching a query.\n - Retrieve full message payloads.\n - Retrieve full thread payloads.\n\n **Lifecycle:**\n\n - Adapters are intentionally read-only and must not mutate provider state.",
|
||||
"members": {
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.base.MailIntakeAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str) -> Iterator[dict[str, str]]",
|
||||
"docstring": "Iterate over lightweight message references matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[dict[str, str]]:\n An iterator over lightweight message reference dictionaries.\n\nYields:\n dict[str, str]:\n Dictionaries containing message and thread identifiers.\n\nNotes:\n **Guarantees:**\n\n - Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n\nExample:\n Typical yield:\n\n ```python\n {\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n }\n ```"
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.base.MailIntakeAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str) -> dict[str, Any]",
|
||||
"docstring": "Fetch a full raw message by message identifier.\n\nArgs:\n message_id (str):\n Provider-specific message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native message payload (e.g., Gmail message JSON structure)."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.base.MailIntakeAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str) -> dict[str, Any]",
|
||||
"docstring": "Fetch a full raw thread by thread identifier.\n\nArgs:\n thread_id (str):\n Provider-specific thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native thread payload."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
99
docs/mcp/modules/mail_intake.adapters.gmail.json
Normal file
99
docs/mcp/modules/mail_intake.adapters.gmail.json
Normal file
@@ -0,0 +1,99 @@
|
||||
{
|
||||
"module": "mail_intake.adapters.gmail",
|
||||
"content": {
|
||||
"path": "mail_intake.adapters.gmail",
|
||||
"docstring": "# Summary\n\nGmail adapter implementation for Mail Intake.\n\nThis module provides a **Gmail-specific implementation** of the\n`MailIntakeAdapter` contract.\n\nIt is the only place in the codebase where:\n\n- `googleapiclient` is imported.\n- Gmail REST API semantics are known.\n- Low-level `.execute()` calls are made.\n\nAll Gmail-specific behavior must be strictly contained within this module.",
|
||||
"objects": {
|
||||
"MailIntakeAdapter": {
|
||||
"name": "MailIntakeAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapter",
|
||||
"signature": null,
|
||||
"docstring": "Base adapter interface for mail providers.\n\nNotes:\n **Guarantees:**\n\n - Discover messages matching a query.\n - Retrieve full message payloads.\n - Retrieve full thread payloads.\n\n **Lifecycle:**\n\n - Adapters are intentionally read-only and must not mutate provider state.",
|
||||
"members": {
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str)",
|
||||
"docstring": "Iterate over lightweight message references matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[dict[str, str]]:\n An iterator over lightweight message reference dictionaries.\n\nYields:\n dict[str, str]:\n Dictionaries containing message and thread identifiers.\n\nNotes:\n **Guarantees:**\n\n - Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n\nExample:\n Typical yield:\n\n ```python\n {\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n }\n ```"
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str)",
|
||||
"docstring": "Fetch a full raw message by message identifier.\n\nArgs:\n message_id (str):\n Provider-specific message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native message payload (e.g., Gmail message JSON structure)."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str)",
|
||||
"docstring": "Fetch a full raw thread by thread identifier.\n\nArgs:\n thread_id (str):\n Provider-specific thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native thread payload."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeAuthProvider": {
|
||||
"name": "MailIntakeAuthProvider",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAuthProvider",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class for authentication providers.\n\nThis interface enforces a strict contract between authentication\nproviders and mail adapters by requiring providers to explicitly\ndeclare the type of credentials they return.\n\nNotes:\n **Responsibilities:**\n\n - Acquire credentials from an external provider.\n - Refresh or revalidate credentials as needed.\n - Handle authentication-specific failure modes.\n - Coordinate with credential persistence layers where applicable.\n\n **Constraints:**\n\n - Mail adapters must treat returned credentials as opaque and\n provider-specific.\n - Mail adapters rely only on the declared credential type expected\n by the adapter.",
|
||||
"members": {
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAuthProvider.get_credentials",
|
||||
"signature": "get_credentials()",
|
||||
"docstring": "Retrieve valid, provider-specific credentials.\n\nReturns:\n T:\n Credentials of type `T` suitable for immediate use by the\n corresponding mail adapter.\n\nRaises:\n Exception:\n An authentication-specific exception indicating that\n credentials could not be obtained or validated.\n\nNotes:\n **Guarantees:**\n\n - This method is synchronous by design.\n - Represents the sole entry point through which adapters obtain\n authentication material.\n - Implementations must either return credentials of the declared\n type `T` that are valid at the time of return or raise an exception."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeAdapterError": {
|
||||
"name": "MailIntakeAdapterError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapterError",
|
||||
"signature": null,
|
||||
"docstring": "Errors raised by mail provider adapters.\n\nNotes:\n **Lifecycle:**\n\n - Raised when a provider adapter encounters API errors, transport\n failures, or invalid provider responses."
|
||||
},
|
||||
"MailIntakeGmailAdapter": {
|
||||
"name": "MailIntakeGmailAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter",
|
||||
"signature": "MailIntakeGmailAdapter(auth_provider: MailIntakeAuthProvider[Any], user_id: str = 'me')",
|
||||
"docstring": "Gmail read-only adapter.\n\nThis adapter implements the `MailIntakeAdapter` interface using the\nGmail REST API. It translates the generic mail intake contract into\nGmail-specific API calls.\n\nNotes:\n **Responsibilities:**\n\n - This class is the ONLY place where `googleapiclient` is imported.\n - Gmail REST semantics are known.\n - `.execute()` is called.\n\n **Constraints:**\n\n - Must remain thin and imperative.\n - Must not perform parsing or interpretation.\n - Must not expose Gmail-specific types beyond this class.",
|
||||
"members": {
|
||||
"service": {
|
||||
"name": "service",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter.service",
|
||||
"signature": null,
|
||||
"docstring": "Lazily initialize and return the Gmail API service client.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail service cannot be initialized."
|
||||
},
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str) -> Iterator[dict[str, str]]",
|
||||
"docstring": "Iterate over message references matching the query.\n\nArgs:\n query (str):\n Gmail search query string.\n\nYields:\n dict[str, str]:\n Dictionaries containing ``message_id`` and ``thread_id``.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str) -> dict[str, Any]",
|
||||
"docstring": "Fetch a full Gmail message by message ID.\n\nArgs:\n message_id (str):\n Gmail message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native Gmail message payload.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str) -> dict[str, Any]",
|
||||
"docstring": "Fetch a full Gmail thread by thread ID.\n\nArgs:\n thread_id (str):\n Gmail thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native Gmail thread payload.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
214
docs/mcp/modules/mail_intake.adapters.json
Normal file
214
docs/mcp/modules/mail_intake.adapters.json
Normal file
@@ -0,0 +1,214 @@
|
||||
{
|
||||
"module": "mail_intake.adapters",
|
||||
"content": {
|
||||
"path": "mail_intake.adapters",
|
||||
"docstring": "# Summary\n\nMail provider adapter implementations for Mail Intake.\n\nThis package contains **adapter-layer implementations** responsible for\ninterfacing with external mail providers and exposing a normalized,\nprovider-agnostic contract to the rest of the system.\n\nAdapters in this package:\n\n- Implement the `MailIntakeAdapter` interface.\n- Encapsulate all provider-specific APIs and semantics.\n- Perform read-only access to mail data.\n- Return provider-native payloads without interpretation.\n\nProvider-specific logic **must not leak** outside of adapter implementations.\nAll parsings, normalizations, and transformations must be handled by downstream\ncomponents.\n\n---\n\n# Public API\n\n- `MailIntakeAdapter`\n- `MailIntakeGmailAdapter`\n\n---",
|
||||
"objects": {
|
||||
"MailIntakeAdapter": {
|
||||
"name": "MailIntakeAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.MailIntakeAdapter",
|
||||
"signature": null,
|
||||
"docstring": "Base adapter interface for mail providers.\n\nNotes:\n **Guarantees:**\n\n - Discover messages matching a query.\n - Retrieve full message payloads.\n - Retrieve full thread payloads.\n\n **Lifecycle:**\n\n - Adapters are intentionally read-only and must not mutate provider state.",
|
||||
"members": {
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.MailIntakeAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str)",
|
||||
"docstring": "Iterate over lightweight message references matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[dict[str, str]]:\n An iterator over lightweight message reference dictionaries.\n\nYields:\n dict[str, str]:\n Dictionaries containing message and thread identifiers.\n\nNotes:\n **Guarantees:**\n\n - Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n\nExample:\n Typical yield:\n\n ```python\n {\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n }\n ```"
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.MailIntakeAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str)",
|
||||
"docstring": "Fetch a full raw message by message identifier.\n\nArgs:\n message_id (str):\n Provider-specific message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native message payload (e.g., Gmail message JSON structure)."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.MailIntakeAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str)",
|
||||
"docstring": "Fetch a full raw thread by thread identifier.\n\nArgs:\n thread_id (str):\n Provider-specific thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native thread payload."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeGmailAdapter": {
|
||||
"name": "MailIntakeGmailAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.MailIntakeGmailAdapter",
|
||||
"signature": "MailIntakeGmailAdapter(auth_provider: MailIntakeAuthProvider[Any], user_id: str = 'me')",
|
||||
"docstring": "Gmail read-only adapter.\n\nThis adapter implements the `MailIntakeAdapter` interface using the\nGmail REST API. It translates the generic mail intake contract into\nGmail-specific API calls.\n\nNotes:\n **Responsibilities:**\n\n - This class is the ONLY place where `googleapiclient` is imported.\n - Gmail REST semantics are known.\n - `.execute()` is called.\n\n **Constraints:**\n\n - Must remain thin and imperative.\n - Must not perform parsing or interpretation.\n - Must not expose Gmail-specific types beyond this class.",
|
||||
"members": {
|
||||
"service": {
|
||||
"name": "service",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.adapters.MailIntakeGmailAdapter.service",
|
||||
"signature": null,
|
||||
"docstring": "Lazily initialize and return the Gmail API service client.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail service cannot be initialized."
|
||||
},
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.MailIntakeGmailAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str)",
|
||||
"docstring": "Iterate over message references matching the query.\n\nArgs:\n query (str):\n Gmail search query string.\n\nYields:\n dict[str, str]:\n Dictionaries containing ``message_id`` and ``thread_id``.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.MailIntakeGmailAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str)",
|
||||
"docstring": "Fetch a full Gmail message by message ID.\n\nArgs:\n message_id (str):\n Gmail message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native Gmail message payload.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.MailIntakeGmailAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str)",
|
||||
"docstring": "Fetch a full Gmail thread by thread ID.\n\nArgs:\n thread_id (str):\n Gmail thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native Gmail thread payload.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
}
|
||||
}
|
||||
},
|
||||
"base": {
|
||||
"name": "base",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.adapters.base",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nMail provider adapter contracts for Mail Intake.\n\nThis module defines the **provider-agnostic adapter interface** used for\nread-only mail ingestion.\n\nAdapters encapsulate all provider-specific access logic and expose a\nminimal, normalized contract to the rest of the system. No provider-specific\ntypes or semantics should leak beyond implementations of this interface.",
|
||||
"members": {
|
||||
"MailIntakeAdapter": {
|
||||
"name": "MailIntakeAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.base.MailIntakeAdapter",
|
||||
"signature": null,
|
||||
"docstring": "Base adapter interface for mail providers.\n\nNotes:\n **Guarantees:**\n\n - Discover messages matching a query.\n - Retrieve full message payloads.\n - Retrieve full thread payloads.\n\n **Lifecycle:**\n\n - Adapters are intentionally read-only and must not mutate provider state.",
|
||||
"members": {
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.base.MailIntakeAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str) -> Iterator[dict[str, str]]",
|
||||
"docstring": "Iterate over lightweight message references matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[dict[str, str]]:\n An iterator over lightweight message reference dictionaries.\n\nYields:\n dict[str, str]:\n Dictionaries containing message and thread identifiers.\n\nNotes:\n **Guarantees:**\n\n - Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n\nExample:\n Typical yield:\n\n ```python\n {\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n }\n ```"
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.base.MailIntakeAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str) -> dict[str, Any]",
|
||||
"docstring": "Fetch a full raw message by message identifier.\n\nArgs:\n message_id (str):\n Provider-specific message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native message payload (e.g., Gmail message JSON structure)."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.base.MailIntakeAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str) -> dict[str, Any]",
|
||||
"docstring": "Fetch a full raw thread by thread identifier.\n\nArgs:\n thread_id (str):\n Provider-specific thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native thread payload."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"gmail": {
|
||||
"name": "gmail",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.adapters.gmail",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nGmail adapter implementation for Mail Intake.\n\nThis module provides a **Gmail-specific implementation** of the\n`MailIntakeAdapter` contract.\n\nIt is the only place in the codebase where:\n\n- `googleapiclient` is imported.\n- Gmail REST API semantics are known.\n- Low-level `.execute()` calls are made.\n\nAll Gmail-specific behavior must be strictly contained within this module.",
|
||||
"members": {
|
||||
"MailIntakeAdapter": {
|
||||
"name": "MailIntakeAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapter",
|
||||
"signature": null,
|
||||
"docstring": "Base adapter interface for mail providers.\n\nNotes:\n **Guarantees:**\n\n - Discover messages matching a query.\n - Retrieve full message payloads.\n - Retrieve full thread payloads.\n\n **Lifecycle:**\n\n - Adapters are intentionally read-only and must not mutate provider state.",
|
||||
"members": {
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str)",
|
||||
"docstring": "Iterate over lightweight message references matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[dict[str, str]]:\n An iterator over lightweight message reference dictionaries.\n\nYields:\n dict[str, str]:\n Dictionaries containing message and thread identifiers.\n\nNotes:\n **Guarantees:**\n\n - Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n\nExample:\n Typical yield:\n\n ```python\n {\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n }\n ```"
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str)",
|
||||
"docstring": "Fetch a full raw message by message identifier.\n\nArgs:\n message_id (str):\n Provider-specific message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native message payload (e.g., Gmail message JSON structure)."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str)",
|
||||
"docstring": "Fetch a full raw thread by thread identifier.\n\nArgs:\n thread_id (str):\n Provider-specific thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native thread payload."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeAuthProvider": {
|
||||
"name": "MailIntakeAuthProvider",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAuthProvider",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class for authentication providers.\n\nThis interface enforces a strict contract between authentication\nproviders and mail adapters by requiring providers to explicitly\ndeclare the type of credentials they return.\n\nNotes:\n **Responsibilities:**\n\n - Acquire credentials from an external provider.\n - Refresh or revalidate credentials as needed.\n - Handle authentication-specific failure modes.\n - Coordinate with credential persistence layers where applicable.\n\n **Constraints:**\n\n - Mail adapters must treat returned credentials as opaque and\n provider-specific.\n - Mail adapters rely only on the declared credential type expected\n by the adapter.",
|
||||
"members": {
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAuthProvider.get_credentials",
|
||||
"signature": "get_credentials()",
|
||||
"docstring": "Retrieve valid, provider-specific credentials.\n\nReturns:\n T:\n Credentials of type `T` suitable for immediate use by the\n corresponding mail adapter.\n\nRaises:\n Exception:\n An authentication-specific exception indicating that\n credentials could not be obtained or validated.\n\nNotes:\n **Guarantees:**\n\n - This method is synchronous by design.\n - Represents the sole entry point through which adapters obtain\n authentication material.\n - Implementations must either return credentials of the declared\n type `T` that are valid at the time of return or raise an exception."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeAdapterError": {
|
||||
"name": "MailIntakeAdapterError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeAdapterError",
|
||||
"signature": null,
|
||||
"docstring": "Errors raised by mail provider adapters.\n\nNotes:\n **Lifecycle:**\n\n - Raised when a provider adapter encounters API errors, transport\n failures, or invalid provider responses."
|
||||
},
|
||||
"MailIntakeGmailAdapter": {
|
||||
"name": "MailIntakeGmailAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter",
|
||||
"signature": "MailIntakeGmailAdapter(auth_provider: MailIntakeAuthProvider[Any], user_id: str = 'me')",
|
||||
"docstring": "Gmail read-only adapter.\n\nThis adapter implements the `MailIntakeAdapter` interface using the\nGmail REST API. It translates the generic mail intake contract into\nGmail-specific API calls.\n\nNotes:\n **Responsibilities:**\n\n - This class is the ONLY place where `googleapiclient` is imported.\n - Gmail REST semantics are known.\n - `.execute()` is called.\n\n **Constraints:**\n\n - Must remain thin and imperative.\n - Must not perform parsing or interpretation.\n - Must not expose Gmail-specific types beyond this class.",
|
||||
"members": {
|
||||
"service": {
|
||||
"name": "service",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter.service",
|
||||
"signature": null,
|
||||
"docstring": "Lazily initialize and return the Gmail API service client.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail service cannot be initialized."
|
||||
},
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str) -> Iterator[dict[str, str]]",
|
||||
"docstring": "Iterate over message references matching the query.\n\nArgs:\n query (str):\n Gmail search query string.\n\nYields:\n dict[str, str]:\n Dictionaries containing ``message_id`` and ``thread_id``.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str) -> dict[str, Any]",
|
||||
"docstring": "Fetch a full Gmail message by message ID.\n\nArgs:\n message_id (str):\n Gmail message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native Gmail message payload.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str) -> dict[str, Any]",
|
||||
"docstring": "Fetch a full Gmail thread by thread ID.\n\nArgs:\n thread_id (str):\n Gmail thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native Gmail thread payload.\n\nRaises:\n MailIntakeAdapterError:\n If the Gmail API returns an error."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
32
docs/mcp/modules/mail_intake.auth.base.json
Normal file
32
docs/mcp/modules/mail_intake.auth.base.json
Normal file
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"module": "mail_intake.auth.base",
|
||||
"content": {
|
||||
"path": "mail_intake.auth.base",
|
||||
"docstring": "# Summary\n\nAuthentication provider contracts for Mail Intake.\n\nThis module defines the **authentication abstraction layer** used by mail\nadapters to obtain provider-specific credentials.\n\nAuthentication concerns are intentionally decoupled from adapter logic.\nAdapters depend only on this interface and must not be aware of how\ncredentials are acquired, refreshed, or persisted.",
|
||||
"objects": {
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.base.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"MailIntakeAuthProvider": {
|
||||
"name": "MailIntakeAuthProvider",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.base.MailIntakeAuthProvider",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class for authentication providers.\n\nThis interface enforces a strict contract between authentication\nproviders and mail adapters by requiring providers to explicitly\ndeclare the type of credentials they return.\n\nNotes:\n **Responsibilities:**\n\n - Acquire credentials from an external provider.\n - Refresh or revalidate credentials as needed.\n - Handle authentication-specific failure modes.\n - Coordinate with credential persistence layers where applicable.\n\n **Constraints:**\n\n - Mail adapters must treat returned credentials as opaque and\n provider-specific.\n - Mail adapters rely only on the declared credential type expected\n by the adapter.",
|
||||
"members": {
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.base.MailIntakeAuthProvider.get_credentials",
|
||||
"signature": "get_credentials() -> T",
|
||||
"docstring": "Retrieve valid, provider-specific credentials.\n\nReturns:\n T:\n Credentials of type `T` suitable for immediate use by the\n corresponding mail adapter.\n\nRaises:\n Exception:\n An authentication-specific exception indicating that\n credentials could not be obtained or validated.\n\nNotes:\n **Guarantees:**\n\n - This method is synchronous by design.\n - Represents the sole entry point through which adapters obtain\n authentication material.\n - Implementations must either return credentials of the declared\n type `T` that are valid at the time of return or raise an exception."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
99
docs/mcp/modules/mail_intake.auth.google.json
Normal file
99
docs/mcp/modules/mail_intake.auth.google.json
Normal file
@@ -0,0 +1,99 @@
|
||||
{
|
||||
"module": "mail_intake.auth.google",
|
||||
"content": {
|
||||
"path": "mail_intake.auth.google",
|
||||
"docstring": "# Summary\n\nGoogle authentication provider implementation for Mail Intake.\n\nThis module provides a **Google OAuth–based authentication provider**\nused primarily for Gmail access.\n\nIt encapsulates all Google-specific authentication concerns, including:\n\n- Credential loading and persistence.\n- Token refresh handling.\n- Interactive OAuth flow initiation.\n- Coordination with a credential persistence layer.\n\nNo Google authentication details should leak outside this module.",
|
||||
"objects": {
|
||||
"MailIntakeAuthProvider": {
|
||||
"name": "MailIntakeAuthProvider",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.google.MailIntakeAuthProvider",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class for authentication providers.\n\nThis interface enforces a strict contract between authentication\nproviders and mail adapters by requiring providers to explicitly\ndeclare the type of credentials they return.\n\nNotes:\n **Responsibilities:**\n\n - Acquire credentials from an external provider.\n - Refresh or revalidate credentials as needed.\n - Handle authentication-specific failure modes.\n - Coordinate with credential persistence layers where applicable.\n\n **Constraints:**\n\n - Mail adapters must treat returned credentials as opaque and\n provider-specific.\n - Mail adapters rely only on the declared credential type expected\n by the adapter.",
|
||||
"members": {
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.MailIntakeAuthProvider.get_credentials",
|
||||
"signature": "get_credentials()",
|
||||
"docstring": "Retrieve valid, provider-specific credentials.\n\nReturns:\n T:\n Credentials of type `T` suitable for immediate use by the\n corresponding mail adapter.\n\nRaises:\n Exception:\n An authentication-specific exception indicating that\n credentials could not be obtained or validated.\n\nNotes:\n **Guarantees:**\n\n - This method is synchronous by design.\n - Represents the sole entry point through which adapters obtain\n authentication material.\n - Implementations must either return credentials of the declared\n type `T` that are valid at the time of return or raise an exception."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.google.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.CredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.CredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.CredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeAuthError": {
|
||||
"name": "MailIntakeAuthError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.google.MailIntakeAuthError",
|
||||
"signature": null,
|
||||
"docstring": "Authentication and credential-related failures.\n\nNotes:\n **Lifecycle:**\n\n - Raised when authentication providers are unable to acquire,\n refresh, or persist valid credentials."
|
||||
},
|
||||
"MailIntakeGoogleAuth": {
|
||||
"name": "MailIntakeGoogleAuth",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth",
|
||||
"signature": "MailIntakeGoogleAuth(credentials_path: str, store: CredentialStore[Any], scopes: Sequence[str])",
|
||||
"docstring": "Google OAuth provider for Gmail access.\n\nThis provider implements the `MailIntakeAuthProvider` interface using\nGoogle's OAuth 2.0 flow and credential management libraries.\n\nNotes:\n **Responsibilities:**\n\n - Load cached credentials from a credential store when available.\n - Refresh expired credentials when possible.\n - Initiate an interactive OAuth flow only when required.\n - Persist refreshed or newly obtained credentials via the store.\n\n **Guarantees:**\n\n - This class is synchronous by design and maintains a minimal\n internal state.",
|
||||
"members": {
|
||||
"credentials_path": {
|
||||
"name": "credentials_path",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth.credentials_path",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"store": {
|
||||
"name": "store",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth.store",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"scopes": {
|
||||
"name": "scopes",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth.scopes",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth.get_credentials",
|
||||
"signature": "get_credentials() -> Any",
|
||||
"docstring": "Retrieve valid Google OAuth credentials.\n\nReturns:\n Credentials:\n A `google.oauth2.credentials.Credentials` instance suitable\n for use with Google API clients.\n\nRaises:\n MailIntakeAuthError:\n If credentials cannot be loaded, refreshed,\n or obtained via interactive authentication.\n\nNotes:\n **Lifecycle:**\n\n - Load cached credentials from the configured credential store.\n - Refresh expired credentials when possible.\n - Perform an interactive OAuth login as a fallback.\n - Persist valid credentials for future use."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
193
docs/mcp/modules/mail_intake.auth.json
Normal file
193
docs/mcp/modules/mail_intake.auth.json
Normal file
@@ -0,0 +1,193 @@
|
||||
{
|
||||
"module": "mail_intake.auth",
|
||||
"content": {
|
||||
"path": "mail_intake.auth",
|
||||
"docstring": "# Summary\n\nAuthentication provider implementations for Mail Intake.\n\nThis package defines the **authentication layer** used by mail adapters\nto obtain provider-specific credentials.\n\nIt exposes:\n\n- A stable, provider-agnostic authentication contract.\n- Concrete authentication providers for supported platforms.\n\nAuthentication providers:\n\n- Are responsible for credential acquisition and lifecycle management.\n- Are intentionally decoupled from adapter logic.\n- May be extended by users to support additional providers.\n\nConsumers should depend on the abstract interface and use concrete\nimplementations only where explicitly required.\n\n---\n\n# Public API\n\n- `MailIntakeAuthProvider`\n- `MailIntakeGoogleAuth`\n\n---",
|
||||
"objects": {
|
||||
"MailIntakeAuthProvider": {
|
||||
"name": "MailIntakeAuthProvider",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.MailIntakeAuthProvider",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class for authentication providers.\n\nThis interface enforces a strict contract between authentication\nproviders and mail adapters by requiring providers to explicitly\ndeclare the type of credentials they return.\n\nNotes:\n **Responsibilities:**\n\n - Acquire credentials from an external provider.\n - Refresh or revalidate credentials as needed.\n - Handle authentication-specific failure modes.\n - Coordinate with credential persistence layers where applicable.\n\n **Constraints:**\n\n - Mail adapters must treat returned credentials as opaque and\n provider-specific.\n - Mail adapters rely only on the declared credential type expected\n by the adapter.",
|
||||
"members": {
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.MailIntakeAuthProvider.get_credentials",
|
||||
"signature": "get_credentials()",
|
||||
"docstring": "Retrieve valid, provider-specific credentials.\n\nReturns:\n T:\n Credentials of type `T` suitable for immediate use by the\n corresponding mail adapter.\n\nRaises:\n Exception:\n An authentication-specific exception indicating that\n credentials could not be obtained or validated.\n\nNotes:\n **Guarantees:**\n\n - This method is synchronous by design.\n - Represents the sole entry point through which adapters obtain\n authentication material.\n - Implementations must either return credentials of the declared\n type `T` that are valid at the time of return or raise an exception."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeGoogleAuth": {
|
||||
"name": "MailIntakeGoogleAuth",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.MailIntakeGoogleAuth",
|
||||
"signature": "MailIntakeGoogleAuth(credentials_path: str, store: CredentialStore[Any], scopes: Sequence[str])",
|
||||
"docstring": "Google OAuth provider for Gmail access.\n\nThis provider implements the `MailIntakeAuthProvider` interface using\nGoogle's OAuth 2.0 flow and credential management libraries.\n\nNotes:\n **Responsibilities:**\n\n - Load cached credentials from a credential store when available.\n - Refresh expired credentials when possible.\n - Initiate an interactive OAuth flow only when required.\n - Persist refreshed or newly obtained credentials via the store.\n\n **Guarantees:**\n\n - This class is synchronous by design and maintains a minimal\n internal state.",
|
||||
"members": {
|
||||
"credentials_path": {
|
||||
"name": "credentials_path",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.MailIntakeGoogleAuth.credentials_path",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"store": {
|
||||
"name": "store",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.MailIntakeGoogleAuth.store",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"scopes": {
|
||||
"name": "scopes",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.MailIntakeGoogleAuth.scopes",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.MailIntakeGoogleAuth.get_credentials",
|
||||
"signature": "get_credentials()",
|
||||
"docstring": "Retrieve valid Google OAuth credentials.\n\nReturns:\n Credentials:\n A `google.oauth2.credentials.Credentials` instance suitable\n for use with Google API clients.\n\nRaises:\n MailIntakeAuthError:\n If credentials cannot be loaded, refreshed,\n or obtained via interactive authentication.\n\nNotes:\n **Lifecycle:**\n\n - Load cached credentials from the configured credential store.\n - Refresh expired credentials when possible.\n - Perform an interactive OAuth login as a fallback.\n - Persist valid credentials for future use."
|
||||
}
|
||||
}
|
||||
},
|
||||
"base": {
|
||||
"name": "base",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.auth.base",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nAuthentication provider contracts for Mail Intake.\n\nThis module defines the **authentication abstraction layer** used by mail\nadapters to obtain provider-specific credentials.\n\nAuthentication concerns are intentionally decoupled from adapter logic.\nAdapters depend only on this interface and must not be aware of how\ncredentials are acquired, refreshed, or persisted.",
|
||||
"members": {
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.base.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"MailIntakeAuthProvider": {
|
||||
"name": "MailIntakeAuthProvider",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.base.MailIntakeAuthProvider",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class for authentication providers.\n\nThis interface enforces a strict contract between authentication\nproviders and mail adapters by requiring providers to explicitly\ndeclare the type of credentials they return.\n\nNotes:\n **Responsibilities:**\n\n - Acquire credentials from an external provider.\n - Refresh or revalidate credentials as needed.\n - Handle authentication-specific failure modes.\n - Coordinate with credential persistence layers where applicable.\n\n **Constraints:**\n\n - Mail adapters must treat returned credentials as opaque and\n provider-specific.\n - Mail adapters rely only on the declared credential type expected\n by the adapter.",
|
||||
"members": {
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.base.MailIntakeAuthProvider.get_credentials",
|
||||
"signature": "get_credentials() -> T",
|
||||
"docstring": "Retrieve valid, provider-specific credentials.\n\nReturns:\n T:\n Credentials of type `T` suitable for immediate use by the\n corresponding mail adapter.\n\nRaises:\n Exception:\n An authentication-specific exception indicating that\n credentials could not be obtained or validated.\n\nNotes:\n **Guarantees:**\n\n - This method is synchronous by design.\n - Represents the sole entry point through which adapters obtain\n authentication material.\n - Implementations must either return credentials of the declared\n type `T` that are valid at the time of return or raise an exception."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"google": {
|
||||
"name": "google",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.auth.google",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nGoogle authentication provider implementation for Mail Intake.\n\nThis module provides a **Google OAuth–based authentication provider**\nused primarily for Gmail access.\n\nIt encapsulates all Google-specific authentication concerns, including:\n\n- Credential loading and persistence.\n- Token refresh handling.\n- Interactive OAuth flow initiation.\n- Coordination with a credential persistence layer.\n\nNo Google authentication details should leak outside this module.",
|
||||
"members": {
|
||||
"MailIntakeAuthProvider": {
|
||||
"name": "MailIntakeAuthProvider",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.google.MailIntakeAuthProvider",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class for authentication providers.\n\nThis interface enforces a strict contract between authentication\nproviders and mail adapters by requiring providers to explicitly\ndeclare the type of credentials they return.\n\nNotes:\n **Responsibilities:**\n\n - Acquire credentials from an external provider.\n - Refresh or revalidate credentials as needed.\n - Handle authentication-specific failure modes.\n - Coordinate with credential persistence layers where applicable.\n\n **Constraints:**\n\n - Mail adapters must treat returned credentials as opaque and\n provider-specific.\n - Mail adapters rely only on the declared credential type expected\n by the adapter.",
|
||||
"members": {
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.MailIntakeAuthProvider.get_credentials",
|
||||
"signature": "get_credentials()",
|
||||
"docstring": "Retrieve valid, provider-specific credentials.\n\nReturns:\n T:\n Credentials of type `T` suitable for immediate use by the\n corresponding mail adapter.\n\nRaises:\n Exception:\n An authentication-specific exception indicating that\n credentials could not be obtained or validated.\n\nNotes:\n **Guarantees:**\n\n - This method is synchronous by design.\n - Represents the sole entry point through which adapters obtain\n authentication material.\n - Implementations must either return credentials of the declared\n type `T` that are valid at the time of return or raise an exception."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.google.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.CredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.CredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.CredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeAuthError": {
|
||||
"name": "MailIntakeAuthError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.google.MailIntakeAuthError",
|
||||
"signature": null,
|
||||
"docstring": "Authentication and credential-related failures.\n\nNotes:\n **Lifecycle:**\n\n - Raised when authentication providers are unable to acquire,\n refresh, or persist valid credentials."
|
||||
},
|
||||
"MailIntakeGoogleAuth": {
|
||||
"name": "MailIntakeGoogleAuth",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth",
|
||||
"signature": "MailIntakeGoogleAuth(credentials_path: str, store: CredentialStore[Any], scopes: Sequence[str])",
|
||||
"docstring": "Google OAuth provider for Gmail access.\n\nThis provider implements the `MailIntakeAuthProvider` interface using\nGoogle's OAuth 2.0 flow and credential management libraries.\n\nNotes:\n **Responsibilities:**\n\n - Load cached credentials from a credential store when available.\n - Refresh expired credentials when possible.\n - Initiate an interactive OAuth flow only when required.\n - Persist refreshed or newly obtained credentials via the store.\n\n **Guarantees:**\n\n - This class is synchronous by design and maintains a minimal\n internal state.",
|
||||
"members": {
|
||||
"credentials_path": {
|
||||
"name": "credentials_path",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth.credentials_path",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"store": {
|
||||
"name": "store",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth.store",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"scopes": {
|
||||
"name": "scopes",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth.scopes",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"get_credentials": {
|
||||
"name": "get_credentials",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.auth.google.MailIntakeGoogleAuth.get_credentials",
|
||||
"signature": "get_credentials() -> Any",
|
||||
"docstring": "Retrieve valid Google OAuth credentials.\n\nReturns:\n Credentials:\n A `google.oauth2.credentials.Credentials` instance suitable\n for use with Google API clients.\n\nRaises:\n MailIntakeAuthError:\n If credentials cannot be loaded, refreshed,\n or obtained via interactive authentication.\n\nNotes:\n **Lifecycle:**\n\n - Load cached credentials from the configured credential store.\n - Refresh expired credentials when possible.\n - Perform an interactive OAuth login as a fallback.\n - Persist valid credentials for future use."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
53
docs/mcp/modules/mail_intake.config.json
Normal file
53
docs/mcp/modules/mail_intake.config.json
Normal file
@@ -0,0 +1,53 @@
|
||||
{
|
||||
"module": "mail_intake.config",
|
||||
"content": {
|
||||
"path": "mail_intake.config",
|
||||
"docstring": "# Summary\n\nGlobal configuration models for Mail Intake.\n\nThis module defines the **top-level configuration object** used to control\nmail ingestion behavior across adapters, authentication providers, and\ningestion workflows.\n\nConfiguration is intentionally explicit, immutable, and free of implicit\nenvironment reads to ensure predictability and testability.",
|
||||
"objects": {
|
||||
"MailIntakeConfig": {
|
||||
"name": "MailIntakeConfig",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.config.MailIntakeConfig",
|
||||
"signature": "MailIntakeConfig(provider: str = ..., user_id: str = ..., readonly: bool = ..., credentials_path: str | None = ..., token_path: str | None = ...)",
|
||||
"docstring": "Global configuration for `mail-intake`.\n\nNotes:\n **Guarantees:**\n\n - This configuration is intentionally explicit and immutable.\n - No implicit environment reads or global state.\n - Explicit configuration over implicit defaults.\n - No direct environment or filesystem access.\n - This model is safe to pass across layers and suitable for\n serialization.",
|
||||
"members": {
|
||||
"provider": {
|
||||
"name": "provider",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.config.MailIntakeConfig.provider",
|
||||
"signature": null,
|
||||
"docstring": "Identifier of the mail provider to use (e.g., ``\"gmail\"``)."
|
||||
},
|
||||
"user_id": {
|
||||
"name": "user_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.config.MailIntakeConfig.user_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific user identifier. Defaults to the authenticated user."
|
||||
},
|
||||
"readonly": {
|
||||
"name": "readonly",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.config.MailIntakeConfig.readonly",
|
||||
"signature": null,
|
||||
"docstring": "Whether ingestion should operate in read-only mode."
|
||||
},
|
||||
"credentials_path": {
|
||||
"name": "credentials_path",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.config.MailIntakeConfig.credentials_path",
|
||||
"signature": null,
|
||||
"docstring": "Optional path to provider credentials configuration."
|
||||
},
|
||||
"token_path": {
|
||||
"name": "token_path",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.config.MailIntakeConfig.token_path",
|
||||
"signature": null,
|
||||
"docstring": "Optional path to persisted authentication tokens."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
381
docs/mcp/modules/mail_intake.credentials.json
Normal file
381
docs/mcp/modules/mail_intake.credentials.json
Normal file
@@ -0,0 +1,381 @@
|
||||
{
|
||||
"module": "mail_intake.credentials",
|
||||
"content": {
|
||||
"path": "mail_intake.credentials",
|
||||
"docstring": "# Summary\n\nCredential persistence interfaces and implementations for Mail Intake.\n\nThis package defines the abstractions and concrete implementations used\nto persist authentication credentials across Mail Intake components.\n\nThe credential persistence layer is intentionally decoupled from\nauthentication logic. Authentication providers are responsible for\ncredential acquisition, validation, and refresh, while implementations\nwithin this package are responsible solely for storage and retrieval.\n\nThe package provides:\n\n- A generic `CredentialStore` abstraction defining the persistence contract.\n- Local filesystem–based storage for development and single-node use.\n- Distributed, Redis-backed storage for production and scaled deployments.\n\nCredential lifecycle management, interpretation, and security policy\ndecisions remain the responsibility of authentication providers.\n\n---\n\n# Public API\n\n- `CredentialStore`\n- `PickleCredentialStore`\n- `RedisCredentialStore`\n\n---",
|
||||
"objects": {
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.CredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.CredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.CredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PickleCredentialStore": {
|
||||
"name": "PickleCredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.PickleCredentialStore",
|
||||
"signature": "PickleCredentialStore(path: str)",
|
||||
"docstring": "Filesystem-backed credential store using pickle serialization.\n\nThis store persists credentials as a pickled object on the local\nfilesystem. It is a simple implementation intended primarily for\ndevelopment, testing, and single-process execution contexts.\n\nNotes:\n **Guarantees:**\n\n - Stores credentials on the local filesystem.\n - Uses `pickle` for serialization and deserialization.\n - Does not provide encryption, locking, or concurrency guarantees.\n\n **Constraints:**\n\n - Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.",
|
||||
"members": {
|
||||
"path": {
|
||||
"name": "path",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.PickleCredentialStore.path",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.PickleCredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load credentials from the local filesystem.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are present and\n successfully deserialized; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - If the credential file does not exist or cannot be successfully\n deserialized, this method returns `None`.\n - The store does not attempt to validate or interpret the\n returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.PickleCredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to the local filesystem.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Responsibilities:**\n\n - Any previously stored credentials at the configured path are overwritten"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.PickleCredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove persisted credentials from the local filesystem.\n\nNotes:\n **Lifecycle:**\n\n - This method deletes the credential file if it exists and should be treated as an idempotent operation"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RedisCredentialStore": {
|
||||
"name": "RedisCredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore",
|
||||
"signature": "RedisCredentialStore(redis_client: Any, key: str, serialize: Callable[[T], bytes], deserialize: Callable[[bytes], T], ttl_seconds: int | None = None)",
|
||||
"docstring": "Redis-backed implementation of `CredentialStore`.\n\nThis store persists credentials in Redis and is suitable for\ndistributed and horizontally scaled deployments where credentials\nmust be shared across multiple processes or nodes.\n\nNotes:\n **Responsibilities:**\n\n - This class is responsible only for persistence and retrieval.\n - It does not interpret, validate, refresh, or otherwise manage the\n lifecycle of the credentials being stored.\n\n **Guarantees:**\n\n - The store is intentionally generic and delegates all serialization\n concerns to caller-provided functions.\n - This avoids unsafe mechanisms such as `pickle` and allows\n credential formats to be explicitly controlled and audited.",
|
||||
"members": {
|
||||
"redis": {
|
||||
"name": "redis",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore.redis",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"key": {
|
||||
"name": "key",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore.key",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"serialize": {
|
||||
"name": "serialize",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore.serialize",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"deserialize": {
|
||||
"name": "deserialize",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore.deserialize",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"ttl_seconds": {
|
||||
"name": "ttl_seconds",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore.ttl_seconds",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load credentials from Redis.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are present and\n successfully deserialized; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - If no value exists for the configured key, or if the stored\n payload cannot be successfully deserialized, this method\n returns `None`.\n - The store does not attempt to validate the returned\n credentials or determine whether they are expired or\n otherwise usable."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to Redis.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Responsibilities:**\n\n - Any previously stored credentials under the same key are overwritten\n - If a TTL is configured, the credentials will expire automatically after the specified duration"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.RedisCredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove stored credentials from Redis.\n\nNotes:\n **Lifecycle:**\n\n - This operation deletes the configured Redis key if it exists\n - Implementations should treat this method as idempotent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"pickle": {
|
||||
"name": "pickle",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.credentials.pickle",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nLocal filesystem–based credential persistence for Mail Intake.\n\nThis module provides a file-backed implementation of the\n`CredentialStore` abstraction using Python's `pickle` module.\n\nThe `pickle`-based credential store is intended for local development,\nsingle-node deployments, and controlled environments where credentials\ndo not need to be shared across processes or machines.\n\nDue to the security and portability risks associated with `pickle`-based\nserialization, this implementation is not suitable for distributed or\nuntrusted environments.",
|
||||
"members": {
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.pickle.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.CredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.CredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.CredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.pickle.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"PickleCredentialStore": {
|
||||
"name": "PickleCredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore",
|
||||
"signature": "PickleCredentialStore(path: str)",
|
||||
"docstring": "Filesystem-backed credential store using pickle serialization.\n\nThis store persists credentials as a pickled object on the local\nfilesystem. It is a simple implementation intended primarily for\ndevelopment, testing, and single-process execution contexts.\n\nNotes:\n **Guarantees:**\n\n - Stores credentials on the local filesystem.\n - Uses `pickle` for serialization and deserialization.\n - Does not provide encryption, locking, or concurrency guarantees.\n\n **Constraints:**\n\n - Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.",
|
||||
"members": {
|
||||
"path": {
|
||||
"name": "path",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore.path",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore.load",
|
||||
"signature": "load() -> T | None",
|
||||
"docstring": "Load credentials from the local filesystem.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are present and\n successfully deserialized; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - If the credential file does not exist or cannot be successfully\n deserialized, this method returns `None`.\n - The store does not attempt to validate or interpret the\n returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore.save",
|
||||
"signature": "save(credentials: T) -> None",
|
||||
"docstring": "Persist credentials to the local filesystem.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Responsibilities:**\n\n - Any previously stored credentials at the configured path are overwritten"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore.clear",
|
||||
"signature": "clear() -> None",
|
||||
"docstring": "Remove persisted credentials from the local filesystem.\n\nNotes:\n **Lifecycle:**\n\n - This method deletes the credential file if it exists and should be treated as an idempotent operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"redis": {
|
||||
"name": "redis",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.credentials.redis",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nRedis-backed credential persistence for Mail Intake.\n\nThis module provides a Redis-based implementation of the\n`CredentialStore` abstraction, enabling credential persistence\nacross distributed and horizontally scaled deployments.\n\nThe Redis credential store is designed for environments where\nauthentication credentials must be shared safely across multiple\nprocesses, containers, or nodes, such as container orchestration\nplatforms and microservice architectures.\n\nKey characteristics:\n\n- Distributed-safe, shared storage using Redis.\n- Explicit, caller-defined serialization and deserialization.\n- No reliance on unsafe mechanisms such as `pickle`.\n- Optional time-to-live (TTL) support for automatic credential expiry.\n\nThis module is responsible solely for persistence concerns.\nCredential validation, refresh, rotation, and acquisition remain the\nresponsibility of authentication provider implementations.",
|
||||
"members": {
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.redis.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.CredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.CredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.CredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"RedisCredentialStore": {
|
||||
"name": "RedisCredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore",
|
||||
"signature": "RedisCredentialStore(redis_client: Any, key: str, serialize: Callable[[T], bytes], deserialize: Callable[[bytes], T], ttl_seconds: int | None = None)",
|
||||
"docstring": "Redis-backed implementation of `CredentialStore`.\n\nThis store persists credentials in Redis and is suitable for\ndistributed and horizontally scaled deployments where credentials\nmust be shared across multiple processes or nodes.\n\nNotes:\n **Responsibilities:**\n\n - This class is responsible only for persistence and retrieval.\n - It does not interpret, validate, refresh, or otherwise manage the\n lifecycle of the credentials being stored.\n\n **Guarantees:**\n\n - The store is intentionally generic and delegates all serialization\n concerns to caller-provided functions.\n - This avoids unsafe mechanisms such as `pickle` and allows\n credential formats to be explicitly controlled and audited.",
|
||||
"members": {
|
||||
"redis": {
|
||||
"name": "redis",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.redis",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"key": {
|
||||
"name": "key",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.key",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"serialize": {
|
||||
"name": "serialize",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.serialize",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"deserialize": {
|
||||
"name": "deserialize",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.deserialize",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"ttl_seconds": {
|
||||
"name": "ttl_seconds",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.ttl_seconds",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.load",
|
||||
"signature": "load() -> T | None",
|
||||
"docstring": "Load credentials from Redis.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are present and\n successfully deserialized; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - If no value exists for the configured key, or if the stored\n payload cannot be successfully deserialized, this method\n returns `None`.\n - The store does not attempt to validate the returned\n credentials or determine whether they are expired or\n otherwise usable."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.save",
|
||||
"signature": "save(credentials: T) -> None",
|
||||
"docstring": "Persist credentials to Redis.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Responsibilities:**\n\n - Any previously stored credentials under the same key are overwritten\n - If a TTL is configured, the credentials will expire automatically after the specified duration"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.clear",
|
||||
"signature": "clear() -> None",
|
||||
"docstring": "Remove stored credentials from Redis.\n\nNotes:\n **Lifecycle:**\n\n - This operation deletes the configured Redis key if it exists\n - Implementations should treat this method as idempotent"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"store": {
|
||||
"name": "store",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.credentials.store",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nCredential persistence abstractions for Mail Intake.\n\nThis module defines the generic persistence contract used to store and\nretrieve authentication credentials across Mail Intake components.\n\nThe `CredentialStore` abstraction establishes a strict separation\nbetween credential *lifecycle management* and credential *storage*.\nAuthentication providers are responsible for acquiring, validating,\nrefreshing, and revoking credentials, while concrete store\nimplementations are responsible solely for persistence concerns.\n\nBy remaining agnostic to credential structure, serialization format,\nand storage backend, this module enables multiple persistence\nstrategies—such as local files, in-memory caches, distributed stores,\nor secrets managers—without coupling authentication logic to any\nspecific storage mechanism.",
|
||||
"members": {
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.store.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.store.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.store.CredentialStore.load",
|
||||
"signature": "load() -> T | None",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.store.CredentialStore.save",
|
||||
"signature": "save(credentials: T) -> None",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.store.CredentialStore.clear",
|
||||
"signature": "clear() -> None",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
83
docs/mcp/modules/mail_intake.credentials.pickle.json
Normal file
83
docs/mcp/modules/mail_intake.credentials.pickle.json
Normal file
@@ -0,0 +1,83 @@
|
||||
{
|
||||
"module": "mail_intake.credentials.pickle",
|
||||
"content": {
|
||||
"path": "mail_intake.credentials.pickle",
|
||||
"docstring": "# Summary\n\nLocal filesystem–based credential persistence for Mail Intake.\n\nThis module provides a file-backed implementation of the\n`CredentialStore` abstraction using Python's `pickle` module.\n\nThe `pickle`-based credential store is intended for local development,\nsingle-node deployments, and controlled environments where credentials\ndo not need to be shared across processes or machines.\n\nDue to the security and portability risks associated with `pickle`-based\nserialization, this implementation is not suitable for distributed or\nuntrusted environments.",
|
||||
"objects": {
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.pickle.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.CredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.CredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.CredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.pickle.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"PickleCredentialStore": {
|
||||
"name": "PickleCredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore",
|
||||
"signature": "PickleCredentialStore(path: str)",
|
||||
"docstring": "Filesystem-backed credential store using pickle serialization.\n\nThis store persists credentials as a pickled object on the local\nfilesystem. It is a simple implementation intended primarily for\ndevelopment, testing, and single-process execution contexts.\n\nNotes:\n **Guarantees:**\n\n - Stores credentials on the local filesystem.\n - Uses `pickle` for serialization and deserialization.\n - Does not provide encryption, locking, or concurrency guarantees.\n\n **Constraints:**\n\n - Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.",
|
||||
"members": {
|
||||
"path": {
|
||||
"name": "path",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore.path",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore.load",
|
||||
"signature": "load() -> T | None",
|
||||
"docstring": "Load credentials from the local filesystem.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are present and\n successfully deserialized; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - If the credential file does not exist or cannot be successfully\n deserialized, this method returns `None`.\n - The store does not attempt to validate or interpret the\n returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore.save",
|
||||
"signature": "save(credentials: T) -> None",
|
||||
"docstring": "Persist credentials to the local filesystem.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Responsibilities:**\n\n - Any previously stored credentials at the configured path are overwritten"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.pickle.PickleCredentialStore.clear",
|
||||
"signature": "clear() -> None",
|
||||
"docstring": "Remove persisted credentials from the local filesystem.\n\nNotes:\n **Lifecycle:**\n\n - This method deletes the credential file if it exists and should be treated as an idempotent operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
111
docs/mcp/modules/mail_intake.credentials.redis.json
Normal file
111
docs/mcp/modules/mail_intake.credentials.redis.json
Normal file
@@ -0,0 +1,111 @@
|
||||
{
|
||||
"module": "mail_intake.credentials.redis",
|
||||
"content": {
|
||||
"path": "mail_intake.credentials.redis",
|
||||
"docstring": "# Summary\n\nRedis-backed credential persistence for Mail Intake.\n\nThis module provides a Redis-based implementation of the\n`CredentialStore` abstraction, enabling credential persistence\nacross distributed and horizontally scaled deployments.\n\nThe Redis credential store is designed for environments where\nauthentication credentials must be shared safely across multiple\nprocesses, containers, or nodes, such as container orchestration\nplatforms and microservice architectures.\n\nKey characteristics:\n\n- Distributed-safe, shared storage using Redis.\n- Explicit, caller-defined serialization and deserialization.\n- No reliance on unsafe mechanisms such as `pickle`.\n- Optional time-to-live (TTL) support for automatic credential expiry.\n\nThis module is responsible solely for persistence concerns.\nCredential validation, refresh, rotation, and acquisition remain the\nresponsibility of authentication provider implementations.",
|
||||
"objects": {
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.redis.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.CredentialStore.load",
|
||||
"signature": "load()",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.CredentialStore.save",
|
||||
"signature": "save(credentials: T)",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.CredentialStore.clear",
|
||||
"signature": "clear()",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"RedisCredentialStore": {
|
||||
"name": "RedisCredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore",
|
||||
"signature": "RedisCredentialStore(redis_client: Any, key: str, serialize: Callable[[T], bytes], deserialize: Callable[[bytes], T], ttl_seconds: int | None = None)",
|
||||
"docstring": "Redis-backed implementation of `CredentialStore`.\n\nThis store persists credentials in Redis and is suitable for\ndistributed and horizontally scaled deployments where credentials\nmust be shared across multiple processes or nodes.\n\nNotes:\n **Responsibilities:**\n\n - This class is responsible only for persistence and retrieval.\n - It does not interpret, validate, refresh, or otherwise manage the\n lifecycle of the credentials being stored.\n\n **Guarantees:**\n\n - The store is intentionally generic and delegates all serialization\n concerns to caller-provided functions.\n - This avoids unsafe mechanisms such as `pickle` and allows\n credential formats to be explicitly controlled and audited.",
|
||||
"members": {
|
||||
"redis": {
|
||||
"name": "redis",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.redis",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"key": {
|
||||
"name": "key",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.key",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"serialize": {
|
||||
"name": "serialize",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.serialize",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"deserialize": {
|
||||
"name": "deserialize",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.deserialize",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"ttl_seconds": {
|
||||
"name": "ttl_seconds",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.ttl_seconds",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.load",
|
||||
"signature": "load() -> T | None",
|
||||
"docstring": "Load credentials from Redis.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are present and\n successfully deserialized; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - If no value exists for the configured key, or if the stored\n payload cannot be successfully deserialized, this method\n returns `None`.\n - The store does not attempt to validate the returned\n credentials or determine whether they are expired or\n otherwise usable."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.save",
|
||||
"signature": "save(credentials: T) -> None",
|
||||
"docstring": "Persist credentials to Redis.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Responsibilities:**\n\n - Any previously stored credentials under the same key are overwritten\n - If a TTL is configured, the credentials will expire automatically after the specified duration"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.redis.RedisCredentialStore.clear",
|
||||
"signature": "clear() -> None",
|
||||
"docstring": "Remove stored credentials from Redis.\n\nNotes:\n **Lifecycle:**\n\n - This operation deletes the configured Redis key if it exists\n - Implementations should treat this method as idempotent"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
46
docs/mcp/modules/mail_intake.credentials.store.json
Normal file
46
docs/mcp/modules/mail_intake.credentials.store.json
Normal file
@@ -0,0 +1,46 @@
|
||||
{
|
||||
"module": "mail_intake.credentials.store",
|
||||
"content": {
|
||||
"path": "mail_intake.credentials.store",
|
||||
"docstring": "# Summary\n\nCredential persistence abstractions for Mail Intake.\n\nThis module defines the generic persistence contract used to store and\nretrieve authentication credentials across Mail Intake components.\n\nThe `CredentialStore` abstraction establishes a strict separation\nbetween credential *lifecycle management* and credential *storage*.\nAuthentication providers are responsible for acquiring, validating,\nrefreshing, and revoking credentials, while concrete store\nimplementations are responsible solely for persistence concerns.\n\nBy remaining agnostic to credential structure, serialization format,\nand storage backend, this module enables multiple persistence\nstrategies—such as local files, in-memory caches, distributed stores,\nor secrets managers—without coupling authentication logic to any\nspecific storage mechanism.",
|
||||
"objects": {
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.credentials.store.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"CredentialStore": {
|
||||
"name": "CredentialStore",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.credentials.store.CredentialStore",
|
||||
"signature": null,
|
||||
"docstring": "Abstract base class defining a generic persistence interface.\n\nUsed for authentication credentials across different backends.\n\nNotes:\n **Responsibilities:**\n\n - Provide persistent storage separating life-cycle management from\n storage mechanics.\n - Keep implementation focused only on persistence.\n\n **Constraints:**\n\n - The store is intentionally agnostic to:\n - The concrete credential type being stored.\n - The serialization format used to persist credentials.\n - The underlying storage backend or durability guarantees.",
|
||||
"members": {
|
||||
"load": {
|
||||
"name": "load",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.store.CredentialStore.load",
|
||||
"signature": "load() -> T | None",
|
||||
"docstring": "Load previously persisted credentials.\n\nReturns:\n T | None:\n An instance of type `T` if credentials are available and\n loadable; otherwise `None`.\n\nNotes:\n **Guarantees:**\n\n - Implementations should return `None` when no credentials are\n present or when stored credentials cannot be successfully\n decoded or deserialized.\n - The store must not attempt to validate, refresh, or otherwise\n interpret the returned credentials."
|
||||
},
|
||||
"save": {
|
||||
"name": "save",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.store.CredentialStore.save",
|
||||
"signature": "save(credentials: T) -> None",
|
||||
"docstring": "Persist credentials to the underlying storage backend.\n\nArgs:\n credentials (T):\n The credential object to persist.\n\nNotes:\n **Lifecycle:**\n\n - This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence\n\n **Responsibilities:**\n\n - Ensuring durability appropriate to the deployment context\n - Applying encryption or access controls where required\n - Overwriting any previously stored credentials"
|
||||
},
|
||||
"clear": {
|
||||
"name": "clear",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.credentials.store.CredentialStore.clear",
|
||||
"signature": "clear() -> None",
|
||||
"docstring": "Remove any persisted credentials from the store.\n\nNotes:\n **Lifecycle:**\n\n - This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable\n - Must ensure that no stale authentication material remains accessible\n\n **Guarantees:**\n\n - Implementations should treat this operation as idempotent"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
37
docs/mcp/modules/mail_intake.exceptions.json
Normal file
37
docs/mcp/modules/mail_intake.exceptions.json
Normal file
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"module": "mail_intake.exceptions",
|
||||
"content": {
|
||||
"path": "mail_intake.exceptions",
|
||||
"docstring": "# Summary\n\nException hierarchy for Mail Intake.\n\nThis module defines the **canonical exception types** used throughout the\nMail Intake library.\n\nAll library-raised errors derive from `MailIntakeError`. Consumers are\nencouraged to catch this base type (or specific subclasses) rather than\nprovider-specific or third-party exceptions.",
|
||||
"objects": {
|
||||
"MailIntakeError": {
|
||||
"name": "MailIntakeError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.exceptions.MailIntakeError",
|
||||
"signature": null,
|
||||
"docstring": "Base exception for all Mail Intake errors.\n\nNotes:\n **Guarantees:**\n\n - This is the root of the Mail Intake exception hierarchy\n - All errors raised by the library must derive from this class\n - Consumers should generally catch this type when handling library-level failures"
|
||||
},
|
||||
"MailIntakeAuthError": {
|
||||
"name": "MailIntakeAuthError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.exceptions.MailIntakeAuthError",
|
||||
"signature": null,
|
||||
"docstring": "Authentication and credential-related failures.\n\nNotes:\n **Lifecycle:**\n\n - Raised when authentication providers are unable to acquire,\n refresh, or persist valid credentials."
|
||||
},
|
||||
"MailIntakeAdapterError": {
|
||||
"name": "MailIntakeAdapterError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.exceptions.MailIntakeAdapterError",
|
||||
"signature": null,
|
||||
"docstring": "Errors raised by mail provider adapters.\n\nNotes:\n **Lifecycle:**\n\n - Raised when a provider adapter encounters API errors, transport\n failures, or invalid provider responses."
|
||||
},
|
||||
"MailIntakeParsingError": {
|
||||
"name": "MailIntakeParsingError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.exceptions.MailIntakeParsingError",
|
||||
"signature": null,
|
||||
"docstring": "Errors encountered while parsing message content.\n\nNotes:\n **Lifecycle:**\n\n - Raised when raw provider payloads cannot be interpreted or\n normalized into internal domain models."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
252
docs/mcp/modules/mail_intake.ingestion.json
Normal file
252
docs/mcp/modules/mail_intake.ingestion.json
Normal file
@@ -0,0 +1,252 @@
|
||||
{
|
||||
"module": "mail_intake.ingestion",
|
||||
"content": {
|
||||
"path": "mail_intake.ingestion",
|
||||
"docstring": "# Summary\n\nMail ingestion orchestration for Mail Intake.\n\nThis package contains **high-level ingestion components** responsible for\ncoordinating mail retrieval, parsing, normalization, and model construction.\n\nIt represents the **top of the ingestion pipeline** and is intended to be the\nprimary interaction surface for library consumers.\n\nComponents in this package:\n\n- Are provider-agnostic.\n- Depend only on adapter and parser contracts.\n- Contain no provider-specific API logic.\n- Expose read-only ingestion workflows.\n\nConsumers are expected to construct a mail adapter and pass it to the\ningestion layer to begin processing messages and threads.\n\n---\n\n# Public API\n\n- `MailIntakeReader`\n\n---",
|
||||
"objects": {
|
||||
"MailIntakeReader": {
|
||||
"name": "MailIntakeReader",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.MailIntakeReader",
|
||||
"signature": "MailIntakeReader(adapter: MailIntakeAdapter)",
|
||||
"docstring": "High-level read-only ingestion interface.\n\nNotes:\n **Responsibilities:**\n\n - This class is the primary entry point for consumers of the\n Mail Intake library.\n - It orchestrates the full ingestion pipeline:\n - Querying the adapter for message references.\n - Fetching raw provider messages.\n - Parsing and normalizing message data.\n - Constructing domain models.\n\n **Constraints:**\n\n - This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.",
|
||||
"members": {
|
||||
"iter_messages": {
|
||||
"name": "iter_messages",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.MailIntakeReader.iter_messages",
|
||||
"signature": "iter_messages(query: str)",
|
||||
"docstring": "Iterate over parsed messages matching a provider query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nYields:\n MailIntakeMessage:\n Fully parsed and normalized `MailIntakeMessage` instances.\n\nRaises:\n MailIntakeParsingError:\n If a message cannot be parsed."
|
||||
},
|
||||
"iter_threads": {
|
||||
"name": "iter_threads",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.MailIntakeReader.iter_threads",
|
||||
"signature": "iter_threads(query: str)",
|
||||
"docstring": "Iterate over threads constructed from messages matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[MailIntakeThread]:\n An iterator over `MailIntakeThread` instances.\n\nRaises:\n `MailIntakeParsingError`:\n If a message cannot be parsed.\n\nNotes:\n **Guarantees:**\n\n - Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages."
|
||||
}
|
||||
}
|
||||
},
|
||||
"reader": {
|
||||
"name": "reader",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.ingestion.reader",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nHigh-level mail ingestion orchestration for Mail Intake.\n\nThis module provides the primary, provider-agnostic entry point for\nreading and processing mail data.\n\nIt coordinates:\n\n- Mail adapter access.\n- Message and thread iteration.\n- Header and body parsing.\n- Normalization and model construction.\n\nNo provider-specific logic or API semantics are permitted in this layer.",
|
||||
"members": {
|
||||
"MailIntakeAdapter": {
|
||||
"name": "MailIntakeAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeAdapter",
|
||||
"signature": null,
|
||||
"docstring": "Base adapter interface for mail providers.\n\nNotes:\n **Guarantees:**\n\n - Discover messages matching a query.\n - Retrieve full message payloads.\n - Retrieve full thread payloads.\n\n **Lifecycle:**\n\n - Adapters are intentionally read-only and must not mutate provider state.",
|
||||
"members": {
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str)",
|
||||
"docstring": "Iterate over lightweight message references matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[dict[str, str]]:\n An iterator over lightweight message reference dictionaries.\n\nYields:\n dict[str, str]:\n Dictionaries containing message and thread identifiers.\n\nNotes:\n **Guarantees:**\n\n - Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n\nExample:\n Typical yield:\n\n ```python\n {\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n }\n ```"
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str)",
|
||||
"docstring": "Fetch a full raw message by message identifier.\n\nArgs:\n message_id (str):\n Provider-specific message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native message payload (e.g., Gmail message JSON structure)."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str)",
|
||||
"docstring": "Fetch a full raw thread by thread identifier.\n\nArgs:\n thread_id (str):\n Provider-specific thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native thread payload."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeParsingError": {
|
||||
"name": "MailIntakeParsingError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeParsingError",
|
||||
"signature": null,
|
||||
"docstring": "Errors encountered while parsing message content.\n\nNotes:\n **Lifecycle:**\n\n - Raised when raw provider payloads cannot be interpreted or\n normalized into internal domain models."
|
||||
},
|
||||
"MailIntakeMessage": {
|
||||
"name": "MailIntakeMessage",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage",
|
||||
"signature": "MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: str | None, subject: str, body_text: str, snippet: str, raw_headers: dict[str, str])",
|
||||
"docstring": "Canonical internal representation of a single email message.\n\nNotes:\n **Guarantees:**\n\n - This model represents a fully parsed and normalized email message.\n - It is intentionally provider-agnostic and suitable for\n persistence, indexing, and downstream processing.\n\n **Constraints:**\n\n - No provider-specific identifiers, payloads, or API semantics\n should appear in this model.",
|
||||
"members": {
|
||||
"message_id": {
|
||||
"name": "message_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.message_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific message identifier."
|
||||
},
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier to which this message belongs."
|
||||
},
|
||||
"timestamp": {
|
||||
"name": "timestamp",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.timestamp",
|
||||
"signature": null,
|
||||
"docstring": "Message timestamp as a timezone-naive UTC datetime."
|
||||
},
|
||||
"from_email": {
|
||||
"name": "from_email",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.from_email",
|
||||
"signature": null,
|
||||
"docstring": "Sender email address."
|
||||
},
|
||||
"from_name": {
|
||||
"name": "from_name",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.from_name",
|
||||
"signature": null,
|
||||
"docstring": "Optional human-readable sender name."
|
||||
},
|
||||
"subject": {
|
||||
"name": "subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.subject",
|
||||
"signature": null,
|
||||
"docstring": "Raw subject line of the message."
|
||||
},
|
||||
"body_text": {
|
||||
"name": "body_text",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.body_text",
|
||||
"signature": null,
|
||||
"docstring": "Extracted plain-text body content of the message."
|
||||
},
|
||||
"snippet": {
|
||||
"name": "snippet",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.snippet",
|
||||
"signature": null,
|
||||
"docstring": "Short provider-supplied preview snippet of the message."
|
||||
},
|
||||
"raw_headers": {
|
||||
"name": "raw_headers",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.raw_headers",
|
||||
"signature": null,
|
||||
"docstring": "Normalized mapping of message headers (header name → value)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeThread": {
|
||||
"name": "MailIntakeThread",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread",
|
||||
"signature": "MailIntakeThread(thread_id: str, normalized_subject: str, participants: set[str] = ..., messages: list[MailIntakeMessage] = ..., last_activity_at: datetime | None = ...)",
|
||||
"docstring": "Canonical internal representation of an email thread.\n\nNotes:\n **Guarantees:**\n\n - A thread groups multiple related messages under a single subject\n and participant set.\n - It is designed to support reasoning over conversational context\n such as job applications, interviews, follow-ups, and ongoing discussions.\n - This model is provider-agnostic and safe to persist.",
|
||||
"members": {
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier."
|
||||
},
|
||||
"normalized_subject": {
|
||||
"name": "normalized_subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.normalized_subject",
|
||||
"signature": null,
|
||||
"docstring": "Normalized subject line used to group related messages."
|
||||
},
|
||||
"participants": {
|
||||
"name": "participants",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.participants",
|
||||
"signature": null,
|
||||
"docstring": "Set of unique participant email addresses observed in the thread."
|
||||
},
|
||||
"messages": {
|
||||
"name": "messages",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.messages",
|
||||
"signature": null,
|
||||
"docstring": "Ordered list of messages belonging to this thread."
|
||||
},
|
||||
"last_activity_at": {
|
||||
"name": "last_activity_at",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.last_activity_at",
|
||||
"signature": null,
|
||||
"docstring": "Timestamp of the most recent message in the thread."
|
||||
},
|
||||
"add_message": {
|
||||
"name": "add_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.add_message",
|
||||
"signature": "add_message(message: MailIntakeMessage)",
|
||||
"docstring": "Add a message to the thread and update derived fields.\n\nArgs:\n message (MailIntakeMessage):\n Parsed mail message to add to the thread.\n\nNotes:\n **Responsibilities:**\n\n - Appends the message to the thread.\n - Tracks unique participants.\n - Updates the last activity timestamp."
|
||||
}
|
||||
}
|
||||
},
|
||||
"extract_body": {
|
||||
"name": "extract_body",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.extract_body",
|
||||
"signature": "extract_body(payload: dict[str, Any])",
|
||||
"docstring": "Extract the best-effort message body from a Gmail payload.\n\nPriority:\n\n1. `text/plain`\n2. `text/html` (stripped to text)\n3. Single-part body\n4. Empty string (if nothing usable found)\n\nArgs:\n payload (dict[str, Any]):\n Provider-native message payload dictionary.\n\nReturns:\n str:\n Extracted plain-text message body."
|
||||
},
|
||||
"extract_sender": {
|
||||
"name": "extract_sender",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.extract_sender",
|
||||
"signature": "extract_sender(headers: dict[str, str])",
|
||||
"docstring": "Extract sender email and optional display name from headers.\n\nArgs:\n headers (dict[str, str]):\n Normalized header dictionary as returned by `parse_headers()`.\n\nReturns:\n tuple[str, str | None]:\n A tuple `(email, name)` where `email` is the sender email address\n and `name` is the display name, or `None` if unavailable.\n\nNotes:\n **Responsibilities:**\n\n - This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n\nExample:\n Typical values:\n\n - `\"John Doe <john@example.com>\"` -> `(\"john@example.com\", \"John Doe\")`\n - `\"john@example.com\"` -> `(\"john@example.com\", None)`"
|
||||
},
|
||||
"parse_headers": {
|
||||
"name": "parse_headers",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.parse_headers",
|
||||
"signature": "parse_headers(raw_headers: list[dict[str, str]])",
|
||||
"docstring": "Convert a list of Gmail-style headers into a normalized dict.\n\nArgs:\n raw_headers (list[dict[str, str]]):\n List of header dictionaries, each containing `name` and `value` keys.\n\nReturns:\n dict[str, str]:\n Dictionary mapping lowercase header names to stripped values.\n\nNotes:\n **Guarantees:**\n\n - Provider payloads (such as Gmail) typically represent headers as a\n list of name/value mappings.\n - This function normalizes them into a case-insensitive dictionary\n keyed by lowercase header names.\n\nExample:\n Typical usage:\n\n ```python\n Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\n Output:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n ```"
|
||||
},
|
||||
"normalize_subject": {
|
||||
"name": "normalize_subject",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.normalize_subject",
|
||||
"signature": "normalize_subject(subject: str)",
|
||||
"docstring": "Normalize an email subject for thread-level comparison.\n\nArgs:\n subject (str):\n Raw subject line from a message header.\n\nReturns:\n str:\n Normalized subject string suitable for thread grouping.\n\nNotes:\n **Responsibilities:**\n\n - Strips common prefixes such as `Re:`, `Fwd:`, and `FW:`.\n - Repeats prefix stripping to handle stacked prefixes.\n - Collapses excessive whitespace.\n - Preserves original casing (no lowercasing).\n\n **Guarantees:**\n\n - This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject."
|
||||
},
|
||||
"MailIntakeReader": {
|
||||
"name": "MailIntakeReader",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeReader",
|
||||
"signature": "MailIntakeReader(adapter: MailIntakeAdapter)",
|
||||
"docstring": "High-level read-only ingestion interface.\n\nNotes:\n **Responsibilities:**\n\n - This class is the primary entry point for consumers of the\n Mail Intake library.\n - It orchestrates the full ingestion pipeline:\n - Querying the adapter for message references.\n - Fetching raw provider messages.\n - Parsing and normalizing message data.\n - Constructing domain models.\n\n **Constraints:**\n\n - This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.",
|
||||
"members": {
|
||||
"iter_messages": {
|
||||
"name": "iter_messages",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeReader.iter_messages",
|
||||
"signature": "iter_messages(query: str) -> Iterator[MailIntakeMessage]",
|
||||
"docstring": "Iterate over parsed messages matching a provider query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nYields:\n MailIntakeMessage:\n Fully parsed and normalized `MailIntakeMessage` instances.\n\nRaises:\n MailIntakeParsingError:\n If a message cannot be parsed."
|
||||
},
|
||||
"iter_threads": {
|
||||
"name": "iter_threads",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeReader.iter_threads",
|
||||
"signature": "iter_threads(query: str) -> Iterator[MailIntakeThread]",
|
||||
"docstring": "Iterate over threads constructed from messages matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[MailIntakeThread]:\n An iterator over `MailIntakeThread` instances.\n\nRaises:\n `MailIntakeParsingError`:\n If a message cannot be parsed.\n\nNotes:\n **Guarantees:**\n\n - Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
220
docs/mcp/modules/mail_intake.ingestion.reader.json
Normal file
220
docs/mcp/modules/mail_intake.ingestion.reader.json
Normal file
@@ -0,0 +1,220 @@
|
||||
{
|
||||
"module": "mail_intake.ingestion.reader",
|
||||
"content": {
|
||||
"path": "mail_intake.ingestion.reader",
|
||||
"docstring": "# Summary\n\nHigh-level mail ingestion orchestration for Mail Intake.\n\nThis module provides the primary, provider-agnostic entry point for\nreading and processing mail data.\n\nIt coordinates:\n\n- Mail adapter access.\n- Message and thread iteration.\n- Header and body parsing.\n- Normalization and model construction.\n\nNo provider-specific logic or API semantics are permitted in this layer.",
|
||||
"objects": {
|
||||
"MailIntakeAdapter": {
|
||||
"name": "MailIntakeAdapter",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeAdapter",
|
||||
"signature": null,
|
||||
"docstring": "Base adapter interface for mail providers.\n\nNotes:\n **Guarantees:**\n\n - Discover messages matching a query.\n - Retrieve full message payloads.\n - Retrieve full thread payloads.\n\n **Lifecycle:**\n\n - Adapters are intentionally read-only and must not mutate provider state.",
|
||||
"members": {
|
||||
"iter_message_refs": {
|
||||
"name": "iter_message_refs",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeAdapter.iter_message_refs",
|
||||
"signature": "iter_message_refs(query: str)",
|
||||
"docstring": "Iterate over lightweight message references matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[dict[str, str]]:\n An iterator over lightweight message reference dictionaries.\n\nYields:\n dict[str, str]:\n Dictionaries containing message and thread identifiers.\n\nNotes:\n **Guarantees:**\n\n - Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n\nExample:\n Typical yield:\n\n ```python\n {\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n }\n ```"
|
||||
},
|
||||
"fetch_message": {
|
||||
"name": "fetch_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeAdapter.fetch_message",
|
||||
"signature": "fetch_message(message_id: str)",
|
||||
"docstring": "Fetch a full raw message by message identifier.\n\nArgs:\n message_id (str):\n Provider-specific message identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native message payload (e.g., Gmail message JSON structure)."
|
||||
},
|
||||
"fetch_thread": {
|
||||
"name": "fetch_thread",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeAdapter.fetch_thread",
|
||||
"signature": "fetch_thread(thread_id: str)",
|
||||
"docstring": "Fetch a full raw thread by thread identifier.\n\nArgs:\n thread_id (str):\n Provider-specific thread identifier.\n\nReturns:\n dict[str, Any]:\n Provider-native thread payload."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeParsingError": {
|
||||
"name": "MailIntakeParsingError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeParsingError",
|
||||
"signature": null,
|
||||
"docstring": "Errors encountered while parsing message content.\n\nNotes:\n **Lifecycle:**\n\n - Raised when raw provider payloads cannot be interpreted or\n normalized into internal domain models."
|
||||
},
|
||||
"MailIntakeMessage": {
|
||||
"name": "MailIntakeMessage",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage",
|
||||
"signature": "MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: str | None, subject: str, body_text: str, snippet: str, raw_headers: dict[str, str])",
|
||||
"docstring": "Canonical internal representation of a single email message.\n\nNotes:\n **Guarantees:**\n\n - This model represents a fully parsed and normalized email message.\n - It is intentionally provider-agnostic and suitable for\n persistence, indexing, and downstream processing.\n\n **Constraints:**\n\n - No provider-specific identifiers, payloads, or API semantics\n should appear in this model.",
|
||||
"members": {
|
||||
"message_id": {
|
||||
"name": "message_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.message_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific message identifier."
|
||||
},
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier to which this message belongs."
|
||||
},
|
||||
"timestamp": {
|
||||
"name": "timestamp",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.timestamp",
|
||||
"signature": null,
|
||||
"docstring": "Message timestamp as a timezone-naive UTC datetime."
|
||||
},
|
||||
"from_email": {
|
||||
"name": "from_email",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.from_email",
|
||||
"signature": null,
|
||||
"docstring": "Sender email address."
|
||||
},
|
||||
"from_name": {
|
||||
"name": "from_name",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.from_name",
|
||||
"signature": null,
|
||||
"docstring": "Optional human-readable sender name."
|
||||
},
|
||||
"subject": {
|
||||
"name": "subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.subject",
|
||||
"signature": null,
|
||||
"docstring": "Raw subject line of the message."
|
||||
},
|
||||
"body_text": {
|
||||
"name": "body_text",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.body_text",
|
||||
"signature": null,
|
||||
"docstring": "Extracted plain-text body content of the message."
|
||||
},
|
||||
"snippet": {
|
||||
"name": "snippet",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.snippet",
|
||||
"signature": null,
|
||||
"docstring": "Short provider-supplied preview snippet of the message."
|
||||
},
|
||||
"raw_headers": {
|
||||
"name": "raw_headers",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeMessage.raw_headers",
|
||||
"signature": null,
|
||||
"docstring": "Normalized mapping of message headers (header name → value)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeThread": {
|
||||
"name": "MailIntakeThread",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread",
|
||||
"signature": "MailIntakeThread(thread_id: str, normalized_subject: str, participants: set[str] = ..., messages: list[MailIntakeMessage] = ..., last_activity_at: datetime | None = ...)",
|
||||
"docstring": "Canonical internal representation of an email thread.\n\nNotes:\n **Guarantees:**\n\n - A thread groups multiple related messages under a single subject\n and participant set.\n - It is designed to support reasoning over conversational context\n such as job applications, interviews, follow-ups, and ongoing discussions.\n - This model is provider-agnostic and safe to persist.",
|
||||
"members": {
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier."
|
||||
},
|
||||
"normalized_subject": {
|
||||
"name": "normalized_subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.normalized_subject",
|
||||
"signature": null,
|
||||
"docstring": "Normalized subject line used to group related messages."
|
||||
},
|
||||
"participants": {
|
||||
"name": "participants",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.participants",
|
||||
"signature": null,
|
||||
"docstring": "Set of unique participant email addresses observed in the thread."
|
||||
},
|
||||
"messages": {
|
||||
"name": "messages",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.messages",
|
||||
"signature": null,
|
||||
"docstring": "Ordered list of messages belonging to this thread."
|
||||
},
|
||||
"last_activity_at": {
|
||||
"name": "last_activity_at",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.last_activity_at",
|
||||
"signature": null,
|
||||
"docstring": "Timestamp of the most recent message in the thread."
|
||||
},
|
||||
"add_message": {
|
||||
"name": "add_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeThread.add_message",
|
||||
"signature": "add_message(message: MailIntakeMessage)",
|
||||
"docstring": "Add a message to the thread and update derived fields.\n\nArgs:\n message (MailIntakeMessage):\n Parsed mail message to add to the thread.\n\nNotes:\n **Responsibilities:**\n\n - Appends the message to the thread.\n - Tracks unique participants.\n - Updates the last activity timestamp."
|
||||
}
|
||||
}
|
||||
},
|
||||
"extract_body": {
|
||||
"name": "extract_body",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.extract_body",
|
||||
"signature": "extract_body(payload: dict[str, Any])",
|
||||
"docstring": "Extract the best-effort message body from a Gmail payload.\n\nPriority:\n\n1. `text/plain`\n2. `text/html` (stripped to text)\n3. Single-part body\n4. Empty string (if nothing usable found)\n\nArgs:\n payload (dict[str, Any]):\n Provider-native message payload dictionary.\n\nReturns:\n str:\n Extracted plain-text message body."
|
||||
},
|
||||
"extract_sender": {
|
||||
"name": "extract_sender",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.extract_sender",
|
||||
"signature": "extract_sender(headers: dict[str, str])",
|
||||
"docstring": "Extract sender email and optional display name from headers.\n\nArgs:\n headers (dict[str, str]):\n Normalized header dictionary as returned by `parse_headers()`.\n\nReturns:\n tuple[str, str | None]:\n A tuple `(email, name)` where `email` is the sender email address\n and `name` is the display name, or `None` if unavailable.\n\nNotes:\n **Responsibilities:**\n\n - This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n\nExample:\n Typical values:\n\n - `\"John Doe <john@example.com>\"` -> `(\"john@example.com\", \"John Doe\")`\n - `\"john@example.com\"` -> `(\"john@example.com\", None)`"
|
||||
},
|
||||
"parse_headers": {
|
||||
"name": "parse_headers",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.parse_headers",
|
||||
"signature": "parse_headers(raw_headers: list[dict[str, str]])",
|
||||
"docstring": "Convert a list of Gmail-style headers into a normalized dict.\n\nArgs:\n raw_headers (list[dict[str, str]]):\n List of header dictionaries, each containing `name` and `value` keys.\n\nReturns:\n dict[str, str]:\n Dictionary mapping lowercase header names to stripped values.\n\nNotes:\n **Guarantees:**\n\n - Provider payloads (such as Gmail) typically represent headers as a\n list of name/value mappings.\n - This function normalizes them into a case-insensitive dictionary\n keyed by lowercase header names.\n\nExample:\n Typical usage:\n\n ```python\n Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\n Output:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n ```"
|
||||
},
|
||||
"normalize_subject": {
|
||||
"name": "normalize_subject",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.normalize_subject",
|
||||
"signature": "normalize_subject(subject: str)",
|
||||
"docstring": "Normalize an email subject for thread-level comparison.\n\nArgs:\n subject (str):\n Raw subject line from a message header.\n\nReturns:\n str:\n Normalized subject string suitable for thread grouping.\n\nNotes:\n **Responsibilities:**\n\n - Strips common prefixes such as `Re:`, `Fwd:`, and `FW:`.\n - Repeats prefix stripping to handle stacked prefixes.\n - Collapses excessive whitespace.\n - Preserves original casing (no lowercasing).\n\n **Guarantees:**\n\n - This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject."
|
||||
},
|
||||
"MailIntakeReader": {
|
||||
"name": "MailIntakeReader",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeReader",
|
||||
"signature": "MailIntakeReader(adapter: MailIntakeAdapter)",
|
||||
"docstring": "High-level read-only ingestion interface.\n\nNotes:\n **Responsibilities:**\n\n - This class is the primary entry point for consumers of the\n Mail Intake library.\n - It orchestrates the full ingestion pipeline:\n - Querying the adapter for message references.\n - Fetching raw provider messages.\n - Parsing and normalizing message data.\n - Constructing domain models.\n\n **Constraints:**\n\n - This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.",
|
||||
"members": {
|
||||
"iter_messages": {
|
||||
"name": "iter_messages",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeReader.iter_messages",
|
||||
"signature": "iter_messages(query: str) -> Iterator[MailIntakeMessage]",
|
||||
"docstring": "Iterate over parsed messages matching a provider query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nYields:\n MailIntakeMessage:\n Fully parsed and normalized `MailIntakeMessage` instances.\n\nRaises:\n MailIntakeParsingError:\n If a message cannot be parsed."
|
||||
},
|
||||
"iter_threads": {
|
||||
"name": "iter_threads",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.ingestion.reader.MailIntakeReader.iter_threads",
|
||||
"signature": "iter_threads(query: str) -> Iterator[MailIntakeThread]",
|
||||
"docstring": "Iterate over threads constructed from messages matching a query.\n\nArgs:\n query (str):\n Provider-specific query string used to filter messages.\n\nReturns:\n Iterator[MailIntakeThread]:\n An iterator over `MailIntakeThread` instances.\n\nRaises:\n `MailIntakeParsingError`:\n If a message cannot be parsed.\n\nNotes:\n **Guarantees:**\n\n - Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
1583
docs/mcp/modules/mail_intake.json
Normal file
1583
docs/mcp/modules/mail_intake.json
Normal file
File diff suppressed because it is too large
Load Diff
345
docs/mcp/modules/mail_intake.models.json
Normal file
345
docs/mcp/modules/mail_intake.models.json
Normal file
@@ -0,0 +1,345 @@
|
||||
{
|
||||
"module": "mail_intake.models",
|
||||
"content": {
|
||||
"path": "mail_intake.models",
|
||||
"docstring": "# Summary\n\nDomain models for Mail Intake.\n\nThis package defines the **canonical, provider-agnostic data models**\nused throughout the Mail Intake ingestion pipeline.\n\nModels in this package:\n\n- Represent fully parsed and normalized mail data.\n- Are safe to persist, serialize, and index.\n- Contain no provider-specific payloads or API semantics.\n- Serve as stable inputs for downstream processing and analysis.\n\nThese models form the core internal data contract of the library.\n\n---\n\n# Public API\n\n- `MailIntakeMessage`\n- `MailIntakeThread`\n\n---",
|
||||
"objects": {
|
||||
"MailIntakeMessage": {
|
||||
"name": "MailIntakeMessage",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.models.MailIntakeMessage",
|
||||
"signature": "MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: str | None, subject: str, body_text: str, snippet: str, raw_headers: dict[str, str])",
|
||||
"docstring": "Canonical internal representation of a single email message.\n\nNotes:\n **Guarantees:**\n\n - This model represents a fully parsed and normalized email message.\n - It is intentionally provider-agnostic and suitable for\n persistence, indexing, and downstream processing.\n\n **Constraints:**\n\n - No provider-specific identifiers, payloads, or API semantics\n should appear in this model.",
|
||||
"members": {
|
||||
"message_id": {
|
||||
"name": "message_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.message_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific message identifier."
|
||||
},
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier to which this message belongs."
|
||||
},
|
||||
"timestamp": {
|
||||
"name": "timestamp",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.timestamp",
|
||||
"signature": null,
|
||||
"docstring": "Message timestamp as a timezone-naive UTC datetime."
|
||||
},
|
||||
"from_email": {
|
||||
"name": "from_email",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.from_email",
|
||||
"signature": null,
|
||||
"docstring": "Sender email address."
|
||||
},
|
||||
"from_name": {
|
||||
"name": "from_name",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.from_name",
|
||||
"signature": null,
|
||||
"docstring": "Optional human-readable sender name."
|
||||
},
|
||||
"subject": {
|
||||
"name": "subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.subject",
|
||||
"signature": null,
|
||||
"docstring": "Raw subject line of the message."
|
||||
},
|
||||
"body_text": {
|
||||
"name": "body_text",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.body_text",
|
||||
"signature": null,
|
||||
"docstring": "Extracted plain-text body content of the message."
|
||||
},
|
||||
"snippet": {
|
||||
"name": "snippet",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.snippet",
|
||||
"signature": null,
|
||||
"docstring": "Short provider-supplied preview snippet of the message."
|
||||
},
|
||||
"raw_headers": {
|
||||
"name": "raw_headers",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeMessage.raw_headers",
|
||||
"signature": null,
|
||||
"docstring": "Normalized mapping of message headers (header name → value)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeThread": {
|
||||
"name": "MailIntakeThread",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.models.MailIntakeThread",
|
||||
"signature": "MailIntakeThread(thread_id: str, normalized_subject: str, participants: set[str] = ..., messages: list[MailIntakeMessage] = ..., last_activity_at: datetime | None = ...)",
|
||||
"docstring": "Canonical internal representation of an email thread.\n\nNotes:\n **Guarantees:**\n\n - A thread groups multiple related messages under a single subject\n and participant set.\n - It is designed to support reasoning over conversational context\n such as job applications, interviews, follow-ups, and ongoing discussions.\n - This model is provider-agnostic and safe to persist.",
|
||||
"members": {
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeThread.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier."
|
||||
},
|
||||
"normalized_subject": {
|
||||
"name": "normalized_subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeThread.normalized_subject",
|
||||
"signature": null,
|
||||
"docstring": "Normalized subject line used to group related messages."
|
||||
},
|
||||
"participants": {
|
||||
"name": "participants",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeThread.participants",
|
||||
"signature": null,
|
||||
"docstring": "Set of unique participant email addresses observed in the thread."
|
||||
},
|
||||
"messages": {
|
||||
"name": "messages",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeThread.messages",
|
||||
"signature": null,
|
||||
"docstring": "Ordered list of messages belonging to this thread."
|
||||
},
|
||||
"last_activity_at": {
|
||||
"name": "last_activity_at",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.MailIntakeThread.last_activity_at",
|
||||
"signature": null,
|
||||
"docstring": "Timestamp of the most recent message in the thread."
|
||||
},
|
||||
"add_message": {
|
||||
"name": "add_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.models.MailIntakeThread.add_message",
|
||||
"signature": "add_message(message: MailIntakeMessage)",
|
||||
"docstring": "Add a message to the thread and update derived fields.\n\nArgs:\n message (MailIntakeMessage):\n Parsed mail message to add to the thread.\n\nNotes:\n **Responsibilities:**\n\n - Appends the message to the thread.\n - Tracks unique participants.\n - Updates the last activity timestamp."
|
||||
}
|
||||
}
|
||||
},
|
||||
"message": {
|
||||
"name": "message",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.models.message",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nMessage domain models for Mail Intake.\n\nThis module defines the **canonical, provider-agnostic representation**\nof an individual email message as used internally by the Mail Intake\ningestion pipeline.\n\nModels in this module are safe to persist and must not contain any\nprovider-specific fields or semantics.",
|
||||
"members": {
|
||||
"MailIntakeMessage": {
|
||||
"name": "MailIntakeMessage",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage",
|
||||
"signature": "MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: str | None, subject: str, body_text: str, snippet: str, raw_headers: dict[str, str])",
|
||||
"docstring": "Canonical internal representation of a single email message.\n\nNotes:\n **Guarantees:**\n\n - This model represents a fully parsed and normalized email message.\n - It is intentionally provider-agnostic and suitable for\n persistence, indexing, and downstream processing.\n\n **Constraints:**\n\n - No provider-specific identifiers, payloads, or API semantics\n should appear in this model.",
|
||||
"members": {
|
||||
"message_id": {
|
||||
"name": "message_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.message_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific message identifier."
|
||||
},
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier to which this message belongs."
|
||||
},
|
||||
"timestamp": {
|
||||
"name": "timestamp",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.timestamp",
|
||||
"signature": null,
|
||||
"docstring": "Message timestamp as a timezone-naive UTC datetime."
|
||||
},
|
||||
"from_email": {
|
||||
"name": "from_email",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.from_email",
|
||||
"signature": null,
|
||||
"docstring": "Sender email address."
|
||||
},
|
||||
"from_name": {
|
||||
"name": "from_name",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.from_name",
|
||||
"signature": null,
|
||||
"docstring": "Optional human-readable sender name."
|
||||
},
|
||||
"subject": {
|
||||
"name": "subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.subject",
|
||||
"signature": null,
|
||||
"docstring": "Raw subject line of the message."
|
||||
},
|
||||
"body_text": {
|
||||
"name": "body_text",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.body_text",
|
||||
"signature": null,
|
||||
"docstring": "Extracted plain-text body content of the message."
|
||||
},
|
||||
"snippet": {
|
||||
"name": "snippet",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.snippet",
|
||||
"signature": null,
|
||||
"docstring": "Short provider-supplied preview snippet of the message."
|
||||
},
|
||||
"raw_headers": {
|
||||
"name": "raw_headers",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.raw_headers",
|
||||
"signature": null,
|
||||
"docstring": "Normalized mapping of message headers (header name → value)."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"thread": {
|
||||
"name": "thread",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.models.thread",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nThread domain models for Mail Intake.\n\nThis module defines the **canonical, provider-agnostic representation**\nof an email thread as used internally by the Mail Intake ingestion pipeline.\n\nThreads group related messages and serve as the primary unit of reasoning\nfor higher-level correspondence workflows.",
|
||||
"members": {
|
||||
"MailIntakeMessage": {
|
||||
"name": "MailIntakeMessage",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage",
|
||||
"signature": "MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: str | None, subject: str, body_text: str, snippet: str, raw_headers: dict[str, str])",
|
||||
"docstring": "Canonical internal representation of a single email message.\n\nNotes:\n **Guarantees:**\n\n - This model represents a fully parsed and normalized email message.\n - It is intentionally provider-agnostic and suitable for\n persistence, indexing, and downstream processing.\n\n **Constraints:**\n\n - No provider-specific identifiers, payloads, or API semantics\n should appear in this model.",
|
||||
"members": {
|
||||
"message_id": {
|
||||
"name": "message_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.message_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific message identifier."
|
||||
},
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier to which this message belongs."
|
||||
},
|
||||
"timestamp": {
|
||||
"name": "timestamp",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.timestamp",
|
||||
"signature": null,
|
||||
"docstring": "Message timestamp as a timezone-naive UTC datetime."
|
||||
},
|
||||
"from_email": {
|
||||
"name": "from_email",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.from_email",
|
||||
"signature": null,
|
||||
"docstring": "Sender email address."
|
||||
},
|
||||
"from_name": {
|
||||
"name": "from_name",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.from_name",
|
||||
"signature": null,
|
||||
"docstring": "Optional human-readable sender name."
|
||||
},
|
||||
"subject": {
|
||||
"name": "subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.subject",
|
||||
"signature": null,
|
||||
"docstring": "Raw subject line of the message."
|
||||
},
|
||||
"body_text": {
|
||||
"name": "body_text",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.body_text",
|
||||
"signature": null,
|
||||
"docstring": "Extracted plain-text body content of the message."
|
||||
},
|
||||
"snippet": {
|
||||
"name": "snippet",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.snippet",
|
||||
"signature": null,
|
||||
"docstring": "Short provider-supplied preview snippet of the message."
|
||||
},
|
||||
"raw_headers": {
|
||||
"name": "raw_headers",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.raw_headers",
|
||||
"signature": null,
|
||||
"docstring": "Normalized mapping of message headers (header name → value)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeThread": {
|
||||
"name": "MailIntakeThread",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread",
|
||||
"signature": "MailIntakeThread(thread_id: str, normalized_subject: str, participants: set[str] = ..., messages: list[MailIntakeMessage] = ..., last_activity_at: datetime | None = ...)",
|
||||
"docstring": "Canonical internal representation of an email thread.\n\nNotes:\n **Guarantees:**\n\n - A thread groups multiple related messages under a single subject\n and participant set.\n - It is designed to support reasoning over conversational context\n such as job applications, interviews, follow-ups, and ongoing discussions.\n - This model is provider-agnostic and safe to persist.",
|
||||
"members": {
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier."
|
||||
},
|
||||
"normalized_subject": {
|
||||
"name": "normalized_subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.normalized_subject",
|
||||
"signature": null,
|
||||
"docstring": "Normalized subject line used to group related messages."
|
||||
},
|
||||
"participants": {
|
||||
"name": "participants",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.participants",
|
||||
"signature": null,
|
||||
"docstring": "Set of unique participant email addresses observed in the thread."
|
||||
},
|
||||
"messages": {
|
||||
"name": "messages",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.messages",
|
||||
"signature": null,
|
||||
"docstring": "Ordered list of messages belonging to this thread."
|
||||
},
|
||||
"last_activity_at": {
|
||||
"name": "last_activity_at",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.last_activity_at",
|
||||
"signature": null,
|
||||
"docstring": "Timestamp of the most recent message in the thread."
|
||||
},
|
||||
"add_message": {
|
||||
"name": "add_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.add_message",
|
||||
"signature": "add_message(message: MailIntakeMessage) -> None",
|
||||
"docstring": "Add a message to the thread and update derived fields.\n\nArgs:\n message (MailIntakeMessage):\n Parsed mail message to add to the thread.\n\nNotes:\n **Responsibilities:**\n\n - Appends the message to the thread.\n - Tracks unique participants.\n - Updates the last activity timestamp."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
81
docs/mcp/modules/mail_intake.models.message.json
Normal file
81
docs/mcp/modules/mail_intake.models.message.json
Normal file
@@ -0,0 +1,81 @@
|
||||
{
|
||||
"module": "mail_intake.models.message",
|
||||
"content": {
|
||||
"path": "mail_intake.models.message",
|
||||
"docstring": "# Summary\n\nMessage domain models for Mail Intake.\n\nThis module defines the **canonical, provider-agnostic representation**\nof an individual email message as used internally by the Mail Intake\ningestion pipeline.\n\nModels in this module are safe to persist and must not contain any\nprovider-specific fields or semantics.",
|
||||
"objects": {
|
||||
"MailIntakeMessage": {
|
||||
"name": "MailIntakeMessage",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage",
|
||||
"signature": "MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: str | None, subject: str, body_text: str, snippet: str, raw_headers: dict[str, str])",
|
||||
"docstring": "Canonical internal representation of a single email message.\n\nNotes:\n **Guarantees:**\n\n - This model represents a fully parsed and normalized email message.\n - It is intentionally provider-agnostic and suitable for\n persistence, indexing, and downstream processing.\n\n **Constraints:**\n\n - No provider-specific identifiers, payloads, or API semantics\n should appear in this model.",
|
||||
"members": {
|
||||
"message_id": {
|
||||
"name": "message_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.message_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific message identifier."
|
||||
},
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier to which this message belongs."
|
||||
},
|
||||
"timestamp": {
|
||||
"name": "timestamp",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.timestamp",
|
||||
"signature": null,
|
||||
"docstring": "Message timestamp as a timezone-naive UTC datetime."
|
||||
},
|
||||
"from_email": {
|
||||
"name": "from_email",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.from_email",
|
||||
"signature": null,
|
||||
"docstring": "Sender email address."
|
||||
},
|
||||
"from_name": {
|
||||
"name": "from_name",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.from_name",
|
||||
"signature": null,
|
||||
"docstring": "Optional human-readable sender name."
|
||||
},
|
||||
"subject": {
|
||||
"name": "subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.subject",
|
||||
"signature": null,
|
||||
"docstring": "Raw subject line of the message."
|
||||
},
|
||||
"body_text": {
|
||||
"name": "body_text",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.body_text",
|
||||
"signature": null,
|
||||
"docstring": "Extracted plain-text body content of the message."
|
||||
},
|
||||
"snippet": {
|
||||
"name": "snippet",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.snippet",
|
||||
"signature": null,
|
||||
"docstring": "Short provider-supplied preview snippet of the message."
|
||||
},
|
||||
"raw_headers": {
|
||||
"name": "raw_headers",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.message.MailIntakeMessage.raw_headers",
|
||||
"signature": null,
|
||||
"docstring": "Normalized mapping of message headers (header name → value)."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
132
docs/mcp/modules/mail_intake.models.thread.json
Normal file
132
docs/mcp/modules/mail_intake.models.thread.json
Normal file
@@ -0,0 +1,132 @@
|
||||
{
|
||||
"module": "mail_intake.models.thread",
|
||||
"content": {
|
||||
"path": "mail_intake.models.thread",
|
||||
"docstring": "# Summary\n\nThread domain models for Mail Intake.\n\nThis module defines the **canonical, provider-agnostic representation**\nof an email thread as used internally by the Mail Intake ingestion pipeline.\n\nThreads group related messages and serve as the primary unit of reasoning\nfor higher-level correspondence workflows.",
|
||||
"objects": {
|
||||
"MailIntakeMessage": {
|
||||
"name": "MailIntakeMessage",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage",
|
||||
"signature": "MailIntakeMessage(message_id: str, thread_id: str, timestamp: datetime, from_email: str, from_name: str | None, subject: str, body_text: str, snippet: str, raw_headers: dict[str, str])",
|
||||
"docstring": "Canonical internal representation of a single email message.\n\nNotes:\n **Guarantees:**\n\n - This model represents a fully parsed and normalized email message.\n - It is intentionally provider-agnostic and suitable for\n persistence, indexing, and downstream processing.\n\n **Constraints:**\n\n - No provider-specific identifiers, payloads, or API semantics\n should appear in this model.",
|
||||
"members": {
|
||||
"message_id": {
|
||||
"name": "message_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.message_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific message identifier."
|
||||
},
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier to which this message belongs."
|
||||
},
|
||||
"timestamp": {
|
||||
"name": "timestamp",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.timestamp",
|
||||
"signature": null,
|
||||
"docstring": "Message timestamp as a timezone-naive UTC datetime."
|
||||
},
|
||||
"from_email": {
|
||||
"name": "from_email",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.from_email",
|
||||
"signature": null,
|
||||
"docstring": "Sender email address."
|
||||
},
|
||||
"from_name": {
|
||||
"name": "from_name",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.from_name",
|
||||
"signature": null,
|
||||
"docstring": "Optional human-readable sender name."
|
||||
},
|
||||
"subject": {
|
||||
"name": "subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.subject",
|
||||
"signature": null,
|
||||
"docstring": "Raw subject line of the message."
|
||||
},
|
||||
"body_text": {
|
||||
"name": "body_text",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.body_text",
|
||||
"signature": null,
|
||||
"docstring": "Extracted plain-text body content of the message."
|
||||
},
|
||||
"snippet": {
|
||||
"name": "snippet",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.snippet",
|
||||
"signature": null,
|
||||
"docstring": "Short provider-supplied preview snippet of the message."
|
||||
},
|
||||
"raw_headers": {
|
||||
"name": "raw_headers",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeMessage.raw_headers",
|
||||
"signature": null,
|
||||
"docstring": "Normalized mapping of message headers (header name → value)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"MailIntakeThread": {
|
||||
"name": "MailIntakeThread",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread",
|
||||
"signature": "MailIntakeThread(thread_id: str, normalized_subject: str, participants: set[str] = ..., messages: list[MailIntakeMessage] = ..., last_activity_at: datetime | None = ...)",
|
||||
"docstring": "Canonical internal representation of an email thread.\n\nNotes:\n **Guarantees:**\n\n - A thread groups multiple related messages under a single subject\n and participant set.\n - It is designed to support reasoning over conversational context\n such as job applications, interviews, follow-ups, and ongoing discussions.\n - This model is provider-agnostic and safe to persist.",
|
||||
"members": {
|
||||
"thread_id": {
|
||||
"name": "thread_id",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.thread_id",
|
||||
"signature": null,
|
||||
"docstring": "Provider-specific thread identifier."
|
||||
},
|
||||
"normalized_subject": {
|
||||
"name": "normalized_subject",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.normalized_subject",
|
||||
"signature": null,
|
||||
"docstring": "Normalized subject line used to group related messages."
|
||||
},
|
||||
"participants": {
|
||||
"name": "participants",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.participants",
|
||||
"signature": null,
|
||||
"docstring": "Set of unique participant email addresses observed in the thread."
|
||||
},
|
||||
"messages": {
|
||||
"name": "messages",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.messages",
|
||||
"signature": null,
|
||||
"docstring": "Ordered list of messages belonging to this thread."
|
||||
},
|
||||
"last_activity_at": {
|
||||
"name": "last_activity_at",
|
||||
"kind": "attribute",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.last_activity_at",
|
||||
"signature": null,
|
||||
"docstring": "Timestamp of the most recent message in the thread."
|
||||
},
|
||||
"add_message": {
|
||||
"name": "add_message",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.models.thread.MailIntakeThread.add_message",
|
||||
"signature": "add_message(message: MailIntakeMessage) -> None",
|
||||
"docstring": "Add a message to the thread and update derived fields.\n\nArgs:\n message (MailIntakeMessage):\n Parsed mail message to add to the thread.\n\nNotes:\n **Responsibilities:**\n\n - Appends the message to the thread.\n - Tracks unique participants.\n - Updates the last activity timestamp."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
23
docs/mcp/modules/mail_intake.parsers.body.json
Normal file
23
docs/mcp/modules/mail_intake.parsers.body.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"module": "mail_intake.parsers.body",
|
||||
"content": {
|
||||
"path": "mail_intake.parsers.body",
|
||||
"docstring": "# Summary\n\nMessage body extraction utilities for Mail Intake.\n\nThis module contains helper functions for extracting a best-effort\nplain-text body from provider-native message payloads.\n\nThe logic is intentionally tolerant of malformed or partial data and\nprefers human-readable text over fidelity to original formatting.",
|
||||
"objects": {
|
||||
"MailIntakeParsingError": {
|
||||
"name": "MailIntakeParsingError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.parsers.body.MailIntakeParsingError",
|
||||
"signature": null,
|
||||
"docstring": "Errors encountered while parsing message content.\n\nNotes:\n **Lifecycle:**\n\n - Raised when raw provider payloads cannot be interpreted or\n normalized into internal domain models."
|
||||
},
|
||||
"extract_body": {
|
||||
"name": "extract_body",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.body.extract_body",
|
||||
"signature": "extract_body(payload: dict[str, Any]) -> str",
|
||||
"docstring": "Extract the best-effort message body from a Gmail payload.\n\nPriority:\n\n1. `text/plain`\n2. `text/html` (stripped to text)\n3. Single-part body\n4. Empty string (if nothing usable found)\n\nArgs:\n payload (dict[str, Any]):\n Provider-native message payload dictionary.\n\nReturns:\n str:\n Extracted plain-text message body."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
23
docs/mcp/modules/mail_intake.parsers.headers.json
Normal file
23
docs/mcp/modules/mail_intake.parsers.headers.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"module": "mail_intake.parsers.headers",
|
||||
"content": {
|
||||
"path": "mail_intake.parsers.headers",
|
||||
"docstring": "# Summary\n\nMessage header parsing utilities for Mail Intake.\n\nThis module provides helper functions for normalizing and extracting\nuseful information from provider-native message headers.\n\nThe functions here are intentionally simple and tolerant of malformed\nor incomplete header data.",
|
||||
"objects": {
|
||||
"parse_headers": {
|
||||
"name": "parse_headers",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.headers.parse_headers",
|
||||
"signature": "parse_headers(raw_headers: list[dict[str, str]]) -> dict[str, str]",
|
||||
"docstring": "Convert a list of Gmail-style headers into a normalized dict.\n\nArgs:\n raw_headers (list[dict[str, str]]):\n List of header dictionaries, each containing `name` and `value` keys.\n\nReturns:\n dict[str, str]:\n Dictionary mapping lowercase header names to stripped values.\n\nNotes:\n **Guarantees:**\n\n - Provider payloads (such as Gmail) typically represent headers as a\n list of name/value mappings.\n - This function normalizes them into a case-insensitive dictionary\n keyed by lowercase header names.\n\nExample:\n Typical usage:\n\n ```python\n Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\n Output:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n ```"
|
||||
},
|
||||
"extract_sender": {
|
||||
"name": "extract_sender",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.headers.extract_sender",
|
||||
"signature": "extract_sender(headers: dict[str, str]) -> tuple[str, str | None]",
|
||||
"docstring": "Extract sender email and optional display name from headers.\n\nArgs:\n headers (dict[str, str]):\n Normalized header dictionary as returned by `parse_headers()`.\n\nReturns:\n tuple[str, str | None]:\n A tuple `(email, name)` where `email` is the sender email address\n and `name` is the display name, or `None` if unavailable.\n\nNotes:\n **Responsibilities:**\n\n - This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n\nExample:\n Typical values:\n\n - `\"John Doe <john@example.com>\"` -> `(\"john@example.com\", \"John Doe\")`\n - `\"john@example.com\"` -> `(\"john@example.com\", None)`"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
99
docs/mcp/modules/mail_intake.parsers.json
Normal file
99
docs/mcp/modules/mail_intake.parsers.json
Normal file
@@ -0,0 +1,99 @@
|
||||
{
|
||||
"module": "mail_intake.parsers",
|
||||
"content": {
|
||||
"path": "mail_intake.parsers",
|
||||
"docstring": "# Summary\n\nMessage parsing utilities for Mail Intake.\n\nThis package contains **provider-aware but adapter-agnostic parsing helpers**\nused to extract and normalize structured information from raw mail payloads.\n\nParsers in this package are responsible for:\n\n- Interpreting provider-native message structures.\n- Extracting meaningful fields such as headers, body text, and subjects.\n- Normalizing data into consistent internal representations.\n\nThis package does not:\n\n- Perform network or IO operations.\n- Contain provider API logic.\n- Construct domain models directly.\n\nParsing functions are designed to be composable and are orchestrated by the\ningestion layer.\n\n---\n\n# Public API\n\n- `extract_body`\n- `parse_headers`\n- `extract_sender`\n- `normalize_subject`\n\n---",
|
||||
"objects": {
|
||||
"extract_body": {
|
||||
"name": "extract_body",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.extract_body",
|
||||
"signature": "extract_body(payload: dict[str, Any])",
|
||||
"docstring": "Extract the best-effort message body from a Gmail payload.\n\nPriority:\n\n1. `text/plain`\n2. `text/html` (stripped to text)\n3. Single-part body\n4. Empty string (if nothing usable found)\n\nArgs:\n payload (dict[str, Any]):\n Provider-native message payload dictionary.\n\nReturns:\n str:\n Extracted plain-text message body."
|
||||
},
|
||||
"parse_headers": {
|
||||
"name": "parse_headers",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.parse_headers",
|
||||
"signature": "parse_headers(raw_headers: list[dict[str, str]])",
|
||||
"docstring": "Convert a list of Gmail-style headers into a normalized dict.\n\nArgs:\n raw_headers (list[dict[str, str]]):\n List of header dictionaries, each containing `name` and `value` keys.\n\nReturns:\n dict[str, str]:\n Dictionary mapping lowercase header names to stripped values.\n\nNotes:\n **Guarantees:**\n\n - Provider payloads (such as Gmail) typically represent headers as a\n list of name/value mappings.\n - This function normalizes them into a case-insensitive dictionary\n keyed by lowercase header names.\n\nExample:\n Typical usage:\n\n ```python\n Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\n Output:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n ```"
|
||||
},
|
||||
"extract_sender": {
|
||||
"name": "extract_sender",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.extract_sender",
|
||||
"signature": "extract_sender(headers: dict[str, str])",
|
||||
"docstring": "Extract sender email and optional display name from headers.\n\nArgs:\n headers (dict[str, str]):\n Normalized header dictionary as returned by `parse_headers()`.\n\nReturns:\n tuple[str, str | None]:\n A tuple `(email, name)` where `email` is the sender email address\n and `name` is the display name, or `None` if unavailable.\n\nNotes:\n **Responsibilities:**\n\n - This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n\nExample:\n Typical values:\n\n - `\"John Doe <john@example.com>\"` -> `(\"john@example.com\", \"John Doe\")`\n - `\"john@example.com\"` -> `(\"john@example.com\", None)`"
|
||||
},
|
||||
"normalize_subject": {
|
||||
"name": "normalize_subject",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.normalize_subject",
|
||||
"signature": "normalize_subject(subject: str)",
|
||||
"docstring": "Normalize an email subject for thread-level comparison.\n\nArgs:\n subject (str):\n Raw subject line from a message header.\n\nReturns:\n str:\n Normalized subject string suitable for thread grouping.\n\nNotes:\n **Responsibilities:**\n\n - Strips common prefixes such as `Re:`, `Fwd:`, and `FW:`.\n - Repeats prefix stripping to handle stacked prefixes.\n - Collapses excessive whitespace.\n - Preserves original casing (no lowercasing).\n\n **Guarantees:**\n\n - This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject."
|
||||
},
|
||||
"body": {
|
||||
"name": "body",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.parsers.body",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nMessage body extraction utilities for Mail Intake.\n\nThis module contains helper functions for extracting a best-effort\nplain-text body from provider-native message payloads.\n\nThe logic is intentionally tolerant of malformed or partial data and\nprefers human-readable text over fidelity to original formatting.",
|
||||
"members": {
|
||||
"MailIntakeParsingError": {
|
||||
"name": "MailIntakeParsingError",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.parsers.body.MailIntakeParsingError",
|
||||
"signature": null,
|
||||
"docstring": "Errors encountered while parsing message content.\n\nNotes:\n **Lifecycle:**\n\n - Raised when raw provider payloads cannot be interpreted or\n normalized into internal domain models."
|
||||
},
|
||||
"extract_body": {
|
||||
"name": "extract_body",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.body.extract_body",
|
||||
"signature": "extract_body(payload: dict[str, Any]) -> str",
|
||||
"docstring": "Extract the best-effort message body from a Gmail payload.\n\nPriority:\n\n1. `text/plain`\n2. `text/html` (stripped to text)\n3. Single-part body\n4. Empty string (if nothing usable found)\n\nArgs:\n payload (dict[str, Any]):\n Provider-native message payload dictionary.\n\nReturns:\n str:\n Extracted plain-text message body."
|
||||
}
|
||||
}
|
||||
},
|
||||
"headers": {
|
||||
"name": "headers",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.parsers.headers",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nMessage header parsing utilities for Mail Intake.\n\nThis module provides helper functions for normalizing and extracting\nuseful information from provider-native message headers.\n\nThe functions here are intentionally simple and tolerant of malformed\nor incomplete header data.",
|
||||
"members": {
|
||||
"parse_headers": {
|
||||
"name": "parse_headers",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.headers.parse_headers",
|
||||
"signature": "parse_headers(raw_headers: list[dict[str, str]]) -> dict[str, str]",
|
||||
"docstring": "Convert a list of Gmail-style headers into a normalized dict.\n\nArgs:\n raw_headers (list[dict[str, str]]):\n List of header dictionaries, each containing `name` and `value` keys.\n\nReturns:\n dict[str, str]:\n Dictionary mapping lowercase header names to stripped values.\n\nNotes:\n **Guarantees:**\n\n - Provider payloads (such as Gmail) typically represent headers as a\n list of name/value mappings.\n - This function normalizes them into a case-insensitive dictionary\n keyed by lowercase header names.\n\nExample:\n Typical usage:\n\n ```python\n Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\n Output:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n ```"
|
||||
},
|
||||
"extract_sender": {
|
||||
"name": "extract_sender",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.headers.extract_sender",
|
||||
"signature": "extract_sender(headers: dict[str, str]) -> tuple[str, str | None]",
|
||||
"docstring": "Extract sender email and optional display name from headers.\n\nArgs:\n headers (dict[str, str]):\n Normalized header dictionary as returned by `parse_headers()`.\n\nReturns:\n tuple[str, str | None]:\n A tuple `(email, name)` where `email` is the sender email address\n and `name` is the display name, or `None` if unavailable.\n\nNotes:\n **Responsibilities:**\n\n - This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n\nExample:\n Typical values:\n\n - `\"John Doe <john@example.com>\"` -> `(\"john@example.com\", \"John Doe\")`\n - `\"john@example.com\"` -> `(\"john@example.com\", None)`"
|
||||
}
|
||||
}
|
||||
},
|
||||
"subject": {
|
||||
"name": "subject",
|
||||
"kind": "module",
|
||||
"path": "mail_intake.parsers.subject",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nSubject line normalization utilities for Mail Intake.\n\nThis module provides helper functions for normalizing email subject lines\nto enable reliable thread-level comparison and grouping.\n\nNormalization is intentionally conservative to avoid altering semantic\nmeaning while removing common reply and forward prefixes.",
|
||||
"members": {
|
||||
"normalize_subject": {
|
||||
"name": "normalize_subject",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.subject.normalize_subject",
|
||||
"signature": "normalize_subject(subject: str) -> str",
|
||||
"docstring": "Normalize an email subject for thread-level comparison.\n\nArgs:\n subject (str):\n Raw subject line from a message header.\n\nReturns:\n str:\n Normalized subject string suitable for thread grouping.\n\nNotes:\n **Responsibilities:**\n\n - Strips common prefixes such as `Re:`, `Fwd:`, and `FW:`.\n - Repeats prefix stripping to handle stacked prefixes.\n - Collapses excessive whitespace.\n - Preserves original casing (no lowercasing).\n\n **Guarantees:**\n\n - This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
16
docs/mcp/modules/mail_intake.parsers.subject.json
Normal file
16
docs/mcp/modules/mail_intake.parsers.subject.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"module": "mail_intake.parsers.subject",
|
||||
"content": {
|
||||
"path": "mail_intake.parsers.subject",
|
||||
"docstring": "# Summary\n\nSubject line normalization utilities for Mail Intake.\n\nThis module provides helper functions for normalizing email subject lines\nto enable reliable thread-level comparison and grouping.\n\nNormalization is intentionally conservative to avoid altering semantic\nmeaning while removing common reply and forward prefixes.",
|
||||
"objects": {
|
||||
"normalize_subject": {
|
||||
"name": "normalize_subject",
|
||||
"kind": "function",
|
||||
"path": "mail_intake.parsers.subject.normalize_subject",
|
||||
"signature": "normalize_subject(subject: str) -> str",
|
||||
"docstring": "Normalize an email subject for thread-level comparison.\n\nArgs:\n subject (str):\n Raw subject line from a message header.\n\nReturns:\n str:\n Normalized subject string suitable for thread grouping.\n\nNotes:\n **Responsibilities:**\n\n - Strips common prefixes such as `Re:`, `Fwd:`, and `FW:`.\n - Repeats prefix stripping to handle stacked prefixes.\n - Collapses excessive whitespace.\n - Preserves original casing (no lowercasing).\n\n **Guarantees:**\n\n - This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
90
docs/mcp/nav.json
Normal file
90
docs/mcp/nav.json
Normal file
@@ -0,0 +1,90 @@
|
||||
[
|
||||
{
|
||||
"module": "mail_intake",
|
||||
"resource": "docs://modules/mail_intake"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.adapters",
|
||||
"resource": "docs://modules/mail_intake.adapters"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.adapters.base",
|
||||
"resource": "docs://modules/mail_intake.adapters.base"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.adapters.gmail",
|
||||
"resource": "docs://modules/mail_intake.adapters.gmail"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.auth",
|
||||
"resource": "docs://modules/mail_intake.auth"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.auth.base",
|
||||
"resource": "docs://modules/mail_intake.auth.base"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.auth.google",
|
||||
"resource": "docs://modules/mail_intake.auth.google"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.config",
|
||||
"resource": "docs://modules/mail_intake.config"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.credentials",
|
||||
"resource": "docs://modules/mail_intake.credentials"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.credentials.pickle",
|
||||
"resource": "docs://modules/mail_intake.credentials.pickle"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.credentials.redis",
|
||||
"resource": "docs://modules/mail_intake.credentials.redis"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.credentials.store",
|
||||
"resource": "docs://modules/mail_intake.credentials.store"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.exceptions",
|
||||
"resource": "docs://modules/mail_intake.exceptions"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.ingestion",
|
||||
"resource": "docs://modules/mail_intake.ingestion"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.ingestion.reader",
|
||||
"resource": "docs://modules/mail_intake.ingestion.reader"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.models",
|
||||
"resource": "docs://modules/mail_intake.models"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.models.message",
|
||||
"resource": "docs://modules/mail_intake.models.message"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.models.thread",
|
||||
"resource": "docs://modules/mail_intake.models.thread"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.parsers",
|
||||
"resource": "docs://modules/mail_intake.parsers"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.parsers.body",
|
||||
"resource": "docs://modules/mail_intake.parsers.body"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.parsers.headers",
|
||||
"resource": "docs://modules/mail_intake.parsers.headers"
|
||||
},
|
||||
{
|
||||
"module": "mail_intake.parsers.subject",
|
||||
"resource": "docs://modules/mail_intake.parsers.subject"
|
||||
}
|
||||
]
|
||||
100
docs/mkdocs.lib.yml
Normal file
100
docs/mkdocs.lib.yml
Normal file
@@ -0,0 +1,100 @@
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
- scheme: slate
|
||||
primary: deep purple
|
||||
accent: cyan
|
||||
font:
|
||||
text: Inter
|
||||
code: JetBrains Mono
|
||||
features:
|
||||
- navigation.sections
|
||||
- navigation.expand
|
||||
- navigation.top
|
||||
- navigation.instant
|
||||
- navigation.tracking
|
||||
- navigation.indexes
|
||||
- content.code.copy
|
||||
- content.code.annotate
|
||||
- content.tabs.link
|
||||
- content.action.edit
|
||||
- search.highlight
|
||||
- search.share
|
||||
- search.suggest
|
||||
icon:
|
||||
logo: material/inbox
|
||||
repo: fontawesome/brands/github
|
||||
markdown_extensions:
|
||||
- pymdownx.superfences
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.highlight:
|
||||
linenums: true
|
||||
anchor_linenums: true
|
||||
line_spans: __span
|
||||
pygments_lang_class: true
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- tables
|
||||
- footnotes
|
||||
- pymdownx.caret
|
||||
- pymdownx.tilde
|
||||
- pymdownx.mark
|
||||
extra_css:
|
||||
- https://unpkg.com/dracula-prism/dist/css/dracula-prism.css
|
||||
plugins:
|
||||
- search
|
||||
- mkdocstrings:
|
||||
handlers:
|
||||
python:
|
||||
paths:
|
||||
- ..
|
||||
options:
|
||||
docstring_style: google
|
||||
show_source: false
|
||||
show_signature_annotations: true
|
||||
separate_signature: true
|
||||
merge_init_into_class: true
|
||||
inherited_members: true
|
||||
annotations_path: brief
|
||||
show_root_heading: true
|
||||
group_by_category: true
|
||||
show_category_heading: true
|
||||
show_object_full_path: false
|
||||
show_symbol_type_heading: true
|
||||
site_name: mail_intake
|
||||
docs_dir: lib
|
||||
site_dir: ../site/lib
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Core API:
|
||||
- ingestion/index.md
|
||||
- ingestion/reader.md
|
||||
- Domain Models:
|
||||
- models/index.md
|
||||
- models/message.md
|
||||
- models/thread.md
|
||||
- Provider Adapters:
|
||||
- adapters/index.md
|
||||
- adapters/base.md
|
||||
- adapters/gmail.md
|
||||
- Authentication & Storage:
|
||||
- auth/index.md
|
||||
- auth/base.md
|
||||
- auth/google.md
|
||||
- credentials/index.md
|
||||
- credentials/store.md
|
||||
- credentials/pickle.md
|
||||
- credentials/redis.md
|
||||
- Normalization & Parsing:
|
||||
- parsers/index.md
|
||||
- parsers/body.md
|
||||
- parsers/headers.md
|
||||
- parsers/subject.md
|
||||
- Configuration & Errors:
|
||||
- config.md
|
||||
- exceptions.md
|
||||
69
docs/mkdocs.wiki.yml
Normal file
69
docs/mkdocs.wiki.yml
Normal file
@@ -0,0 +1,69 @@
|
||||
site_name: Mail Intake Documentation
|
||||
docs_dir: wiki
|
||||
site_dir: ../site/wiki
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Overview: 01_overview.md
|
||||
- How to Use: 02_how_to_use.md
|
||||
- Extending Mail Intake: 03_extending.md
|
||||
- Development: 04_development.md
|
||||
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
scheme: slate
|
||||
primary: blue grey
|
||||
accent: teal
|
||||
font:
|
||||
text: Roboto
|
||||
code: JetBrains Mono
|
||||
features:
|
||||
- navigation.sections
|
||||
- navigation.expand
|
||||
- navigation.top
|
||||
- navigation.instant
|
||||
- navigation.tracking
|
||||
- navigation.indexes
|
||||
- content.code.copy
|
||||
- content.code.annotate
|
||||
- content.tabs.link
|
||||
- content.action.edit
|
||||
- search.highlight
|
||||
- search.share
|
||||
- search.suggest
|
||||
- navigation.tabs
|
||||
- toc.integrate
|
||||
- header.autohide
|
||||
- announce.dismiss
|
||||
- footer.social
|
||||
- content.code.select
|
||||
- content.code.line_numbers
|
||||
- content.tooltips
|
||||
icon:
|
||||
logo: material/inbox
|
||||
repo: fontawesome/brands/github
|
||||
markdown_extensions:
|
||||
- pymdownx.superfences
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.highlight:
|
||||
linenums: true
|
||||
anchor_linenums: true
|
||||
line_spans: __span
|
||||
pygments_lang_class: true
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- tables
|
||||
- footnotes
|
||||
- pymdownx.caret
|
||||
- pymdownx.tilde
|
||||
- pymdownx.mark
|
||||
extra_css:
|
||||
- https://unpkg.com/dracula-prism/dist/css/dracula-prism.css
|
||||
plugins:
|
||||
- search
|
||||
91
docs/wiki/01_overview.md
Normal file
91
docs/wiki/01_overview.md
Normal file
@@ -0,0 +1,91 @@
|
||||
# 🧱 Overview
|
||||
|
||||
Mail Intake is a **contract-first ingestion pipeline**. Adapters handle
|
||||
transport to a provider, parsers normalize provider payloads, and the reader
|
||||
orchestrates the whole flow into canonical domain models.
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
```text
|
||||
┌─────────────────────────────────────────┐
|
||||
│ External Provider (e.g. Gmail API) │
|
||||
└─────────────────────┬───────────────────┘
|
||||
│
|
||||
┌─────────────────▼──────────────────┐
|
||||
│ MailIntakeAdapter (transport) │ provider API calls
|
||||
└─────────────────┬──────────────────┘
|
||||
│ provider-native payloads
|
||||
┌─────────────────▼──────────────────┐
|
||||
│ Parsers (normalization) │ headers, body, subject
|
||||
└─────────────────┬──────────────────┘
|
||||
│ composed
|
||||
┌─────────────────▼──────────────────┐
|
||||
│ MailIntakeReader (orchestration) │ iter_messages / iter_threads
|
||||
└─────────────────┬──────────────────┘
|
||||
│
|
||||
┌─────────────────▼──────────────────┐
|
||||
│ MailIntakeMessage / Thread │ canonical domain models
|
||||
└────────────────────────────────────┘
|
||||
```
|
||||
|
||||
Layers:
|
||||
|
||||
1. **Adapters** (`mail_intake.adapters`) — provider-specific, read-only
|
||||
transport. Return provider-native payloads; never interpret them.
|
||||
2. **Auth** (`mail_intake.auth`) — credential acquisition and lifecycle
|
||||
management, decoupled from adapters.
|
||||
3. **Credentials** (`mail_intake.credentials`) — persistence of auth tokens;
|
||||
`PickleCredentialStore` locally, `RedisCredentialStore` for production.
|
||||
4. **Parsers** (`mail_intake.parsers`) — extract headers, body text, sender,
|
||||
and normalized subjects from provider payloads.
|
||||
5. **Ingestion** (`mail_intake.ingestion`) — `MailIntakeReader` wires an
|
||||
adapter + parsers into iterators over canonical models.
|
||||
6. **Models** (`mail_intake.models`) — provider-agnostic `MailIntakeMessage`
|
||||
and `MailIntakeThread`.
|
||||
|
||||
---
|
||||
|
||||
## 📦 Domain models
|
||||
|
||||
`MailIntakeMessage`:
|
||||
|
||||
| Field | Type | Meaning |
|
||||
|---|---|---|
|
||||
| `message_id` | `str` | Provider message id |
|
||||
| `thread_id` | `str` | Conversation thread id |
|
||||
| `timestamp` | `datetime` | Message timestamp |
|
||||
| `from_email` | `str` | Sender email |
|
||||
| `from_name` | `str \| None` | Sender display name |
|
||||
| `subject` | `str` | Message subject |
|
||||
| `body_text` | `str` | Extracted plain-text body |
|
||||
| `snippet` | `str` | Provider snippet |
|
||||
| `raw_headers` | `dict[str, str]` | Unmodified headers |
|
||||
|
||||
`MailIntakeThread`:
|
||||
|
||||
| Field | Type | Meaning |
|
||||
|---|---|---|
|
||||
| `thread_id` | `str` | Conversation id |
|
||||
| `normalized_subject` | `str` | Normalized subject (threads share one) |
|
||||
| `participants` | `set[str]` | Distinct senders |
|
||||
| `messages` | `list[MailIntakeMessage]` | Ordered messages |
|
||||
| `last_activity_at` | `datetime \| None` | Latest message time |
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Design guarantees
|
||||
|
||||
- Read-only access — no mutation of provider state.
|
||||
- Provider-agnostic domain models.
|
||||
- Explicit configuration and dependency injection (no implicit env reads).
|
||||
- Extensible via public contracts; built-in adapters are reference
|
||||
implementations and may change internally.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Read Next
|
||||
|
||||
- [How to Use](02_how_to_use.md) — the Gmail ingestion flow.
|
||||
- [Extending Mail Intake](03_extending.md) — custom adapters and stores.
|
||||
105
docs/wiki/02_how_to_use.md
Normal file
105
docs/wiki/02_how_to_use.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# 🖥️ How to Use
|
||||
|
||||
This page walks through authenticating, ingesting, and parsing mail with the
|
||||
built-in Gmail support.
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Authentication
|
||||
|
||||
Create a credential store and an auth provider:
|
||||
|
||||
```python
|
||||
from mail_intake.auth import MailIntakeGoogleAuth
|
||||
from mail_intake.credentials import PickleCredentialStore, RedisCredentialStore
|
||||
|
||||
store = PickleCredentialStore(path="token.pickle") # local dev
|
||||
|
||||
auth = MailIntakeGoogleAuth(
|
||||
credentials_path="credentials.json", # your OAuth client file
|
||||
store=store,
|
||||
scopes=["https://www.googleapis.com/auth/gmail.readonly"],
|
||||
)
|
||||
```
|
||||
|
||||
> OAuth credentials come from the Google Cloud Console and are provided via
|
||||
> file paths — never hard-code tokens or secrets in source. Once authorized,
|
||||
> the token is persisted by the credential store and refreshed automatically.
|
||||
|
||||
For distributed deployments, use Redis instead of pickle:
|
||||
|
||||
```python
|
||||
store = RedisCredentialStore(redis_client=redis_client) # production
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📥 Ingesting messages
|
||||
|
||||
Build an adapter and a reader, then iterate:
|
||||
|
||||
```python
|
||||
from mail_intake.ingestion import MailIntakeReader
|
||||
from mail_intake.adapters import MailIntakeGmailAdapter
|
||||
|
||||
adapter = MailIntakeGmailAdapter(auth_provider=auth)
|
||||
reader = MailIntakeReader(adapter)
|
||||
|
||||
for message in reader.iter_messages("from:recruiter@example.com"):
|
||||
print(message.subject, message.from_email, message.timestamp)
|
||||
```
|
||||
|
||||
Access the full model:
|
||||
|
||||
```python
|
||||
message.message_id # provider id
|
||||
message.thread_id
|
||||
message.body_text # plain-text body
|
||||
message.raw_headers # unmodified headers dict
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔖 Ingesting threads
|
||||
|
||||
```python
|
||||
for thread in reader.iter_threads("subject:Interview"):
|
||||
print(thread.normalized_subject)
|
||||
print(thread.participants)
|
||||
print(len(thread.messages))
|
||||
print(thread.last_activity_at)
|
||||
```
|
||||
|
||||
`MailIntakeThread` aggregates its messages, participants, and last activity.
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Parsers
|
||||
|
||||
Parsers normalize provider payloads and are used by the reader internally.
|
||||
They are also importable on their own:
|
||||
|
||||
```python
|
||||
from mail_intake.parsers import extract_body, parse_headers, normalize_subject
|
||||
```
|
||||
|
||||
- `extract_body(...)` — plain-text body extraction.
|
||||
- `parse_headers(...)` — structured header parsing.
|
||||
- `extract_sender(...)` — sender email/name extraction.
|
||||
- `normalize_subject(...)` — subject normalization for threading.
|
||||
|
||||
---
|
||||
|
||||
## ✅ Checklist
|
||||
|
||||
1. Provide OAuth credentials via a file path and a credential store.
|
||||
2. Build the `MailIntakeGoogleAuth` provider with the Gmail read-only scope.
|
||||
3. Wrap the adapter in a `MailIntakeReader`.
|
||||
4. Consume `iter_messages` / `iter_threads`; never call provider APIs directly.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Read Next
|
||||
|
||||
- [Overview](01_overview.md) — layers and domain models.
|
||||
- [Extending Mail Intake](03_extending.md) — custom providers and stores.
|
||||
106
docs/wiki/03_extending.md
Normal file
106
docs/wiki/03_extending.md
Normal file
@@ -0,0 +1,106 @@
|
||||
# 🧩 Extending Mail Intake
|
||||
|
||||
Mail Intake is designed to be extended through its **public contracts**.
|
||||
Implement your own adapter, auth provider, or credential store to support a
|
||||
new provider or storage backend.
|
||||
|
||||
---
|
||||
|
||||
## 📬 Custom adapters
|
||||
|
||||
Subclass `MailIntakeAdapter` to integrate a new provider. Adapters perform
|
||||
read-only transport and return provider-native payloads:
|
||||
|
||||
```python
|
||||
from mail_intake.adapters import MailIntakeAdapter
|
||||
|
||||
class ExchangeAdapter(MailIntakeAdapter):
|
||||
def __init__(self, auth_provider):
|
||||
self._auth = auth_provider
|
||||
|
||||
def fetch_messages(self, query):
|
||||
# call the provider API, return native payloads
|
||||
...
|
||||
|
||||
def fetch_threads(self, query):
|
||||
...
|
||||
```
|
||||
|
||||
> **Do not** subclass built-in adapters like `MailIntakeGmailAdapter` — they
|
||||
> are reference implementations and may change internally without notice.
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Custom auth providers
|
||||
|
||||
Subclass `MailIntakeAuthProvider[T]` to own a different credential flow:
|
||||
|
||||
```python
|
||||
from mail_intake.auth import MailIntakeAuthProvider
|
||||
|
||||
class ExchangeAuth(MailIntakeAuthProvider[exchange_credentials]):
|
||||
def get_credentials(self):
|
||||
return self._store.load()
|
||||
|
||||
def refresh(self):
|
||||
...
|
||||
```
|
||||
|
||||
Auth providers remain decoupled from adapter logic — they only manage
|
||||
credentials.
|
||||
|
||||
---
|
||||
|
||||
## 🗄️ Custom credential stores
|
||||
|
||||
Implement the `CredentialStore[T]` contract for a new persistence backend:
|
||||
|
||||
```python
|
||||
from mail_intake.credentials import CredentialStore
|
||||
|
||||
class S3CredentialStore(CredentialStore):
|
||||
def save(self, credentials):
|
||||
...
|
||||
|
||||
def load(self):
|
||||
...
|
||||
|
||||
def delete(self):
|
||||
...
|
||||
```
|
||||
|
||||
The store abstraction keeps tokens out of config and rotates safely.
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Wiring a custom backend
|
||||
|
||||
```python
|
||||
from mail_intake.ingestion import MailIntakeReader
|
||||
|
||||
auth = ExchangeAuth(store=S3CredentialStore(...))
|
||||
adapter = ExchangeAdapter(auth_provider=auth)
|
||||
reader = MailIntakeReader(adapter)
|
||||
|
||||
for message in reader.iter_messages("query"):
|
||||
print(message.subject)
|
||||
```
|
||||
|
||||
The reader only depends on the adapter contract, so the rest of the pipeline
|
||||
keeps working unchanged.
|
||||
|
||||
---
|
||||
|
||||
## ✅ Extension checklist
|
||||
|
||||
1. Implement the **public contract** — never subclass built-in adapters.
|
||||
2. Keep transport in the adapter, parsing in parsers, auth in the provider.
|
||||
3. Return the provider-native payload and let parsers normalize it.
|
||||
4. Inject dependencies explicitly — no global state or env reads.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Read Next
|
||||
|
||||
- [How to Use](02_how_to_use.md) — the built-in Gmail flow.
|
||||
- [Development](04_development.md) — running tests and docs.
|
||||
88
docs/wiki/04_development.md
Normal file
88
docs/wiki/04_development.md
Normal file
@@ -0,0 +1,88 @@
|
||||
# 🛠️ Development
|
||||
|
||||
Working on `mail-intake` itself.
|
||||
|
||||
---
|
||||
|
||||
## 📂 Repository layout
|
||||
|
||||
| Path | Purpose |
|
||||
|---|---|
|
||||
| `mail_intake/` | The library package (adapters, auth, credentials, parsers, ingestion, models) |
|
||||
| `mail_intake/*.pyi` | Type stubs kept in sync with implementations |
|
||||
| `tests/` | Unit and integration tests (mock transports, no live mail) |
|
||||
| `docs/lib/` | Generated library reference (docforge, flat layout) |
|
||||
| `docs/mcp/` | Machine-readable bundle served by the MCP server |
|
||||
| `docs/wiki/` | This hand-written wiki |
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Setup
|
||||
|
||||
```bash
|
||||
python -m venv .venv
|
||||
.venv/Scripts/pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
> OAuth credential files (`credentials*.json`, `token.pickle`,
|
||||
> `client_secret_*.json`) are gitignored — keep them out of the repository.
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Tests
|
||||
|
||||
Run the suite (no network or live Gmail required):
|
||||
|
||||
```bash
|
||||
.venv/Scripts/pytest
|
||||
```
|
||||
|
||||
Coverage spans ingestion flows, credential stores, parsers, and auth against
|
||||
mock providers.
|
||||
|
||||
---
|
||||
|
||||
## ✅ Quality gates
|
||||
|
||||
The CI quality gate runs, matching the Drone pipeline:
|
||||
|
||||
```bash
|
||||
.venv/Scripts/black --check .
|
||||
.venv/Scripts/ruff check .
|
||||
.venv/Scripts/mypy
|
||||
.venv/Scripts/pytest
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📝 Building documentation (docforge)
|
||||
|
||||
The site is generated by [`docforge`](https://git.aetoskia.com/aetos/doc-forge)
|
||||
and served per kind under `site/{kind}`:
|
||||
|
||||
```bash
|
||||
doc-forge build \
|
||||
--mkdocs --mcp --wiki \
|
||||
--module-is-source --module mail_intake \
|
||||
--site-name "Mail Intake"
|
||||
```
|
||||
|
||||
- `--module-is-source` renders the flat `docs/lib/` layout (no nesting under
|
||||
`mail_intake/`), matching `docforge.nav.yml` and `docs/mkdocs.lib.yml`.
|
||||
- `--mcp` regenerates the structured bundle in `docs/mcp/`.
|
||||
- `--wiki` builds this wiki.
|
||||
|
||||
Preview locally:
|
||||
|
||||
```bash
|
||||
doc-forge serve --lib
|
||||
doc-forge serve --wiki
|
||||
doc-forge serve --mcp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 Read Next
|
||||
|
||||
- [Extending Mail Intake](03_extending.md) — custom adapters and stores.
|
||||
- [Overview](01_overview.md) — the core architecture.
|
||||
71
docs/wiki/index.md
Normal file
71
docs/wiki/index.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# 📬 Mail Intake — Provider-Agnostic Email Ingestion
|
||||
|
||||
`Mail Intake` is a contract-first, read-only email ingestion framework. It
|
||||
pulls mail from external providers (such as Gmail), parses and normalizes it
|
||||
into clean, provider-agnostic domain models — ready to persist, index, or
|
||||
analyze downstream.
|
||||
|
||||
> **Doc model:** this wiki is written for humans — how‑to guides and extension
|
||||
> recipes. The authoritative API contracts live in the code (GSDFC docstrings)
|
||||
> and the machine‑readable bundle under `docs/mcp/`.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Key Features
|
||||
|
||||
* 📬 **Read-only ingestion** — never mutates provider state
|
||||
* 🧩 **Contract-first layers** — adapters, parsers, and readers separated
|
||||
* ✉️ **Provider-agnostic models** — `MailIntakeMessage` / `MailIntakeThread`
|
||||
have no provider internals
|
||||
* 🔐 **Extensible auth** — pluggable auth providers and credential stores
|
||||
(pickle for dev, Redis for production)
|
||||
* 🧪 **Deterministic & testable** — no implicit global state or env reads
|
||||
* 📊 **Gmail support** — reference adapter built on the official Google APIs
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Quick Start
|
||||
|
||||
```python
|
||||
from mail_intake.ingestion import MailIntakeReader
|
||||
from mail_intake.adapters import MailIntakeGmailAdapter
|
||||
from mail_intake.auth import MailIntakeGoogleAuth
|
||||
from mail_intake.credentials import PickleCredentialStore
|
||||
|
||||
store = PickleCredentialStore(path="token.pickle")
|
||||
|
||||
auth = MailIntakeGoogleAuth(
|
||||
credentials_path="credentials.json",
|
||||
store=store,
|
||||
scopes=["https://www.googleapis.com/auth/gmail.readonly"],
|
||||
)
|
||||
|
||||
adapter = MailIntakeGmailAdapter(auth_provider=auth)
|
||||
reader = MailIntakeReader(adapter)
|
||||
|
||||
for message in reader.iter_messages("from:recruiter@example.com"):
|
||||
print(message.subject, message.from_email)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📁 Documentation Structure
|
||||
|
||||
| Section | What you'll find |
|
||||
|---|---|
|
||||
| [Overview](01_overview.md) | Layers, domain models, and design guarantees |
|
||||
| [How to Use](02_how_to_use.md) | Gmail ingestion, parsing, and credential stores |
|
||||
| [Extending Mail Intake](03_extending.md) | Custom adapters, auth providers, stores |
|
||||
| [Development](04_development.md) | Setup, tests, and regenerating docs |
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related Resources
|
||||
|
||||
* **Source Code:** [Gitea Repository](https://git.aetoskia.com/aetos/mail-intake)
|
||||
* **Internal PyPI:** [pip.aetoskia.com/simple/mail-intake](https://pip.aetoskia.com/simple/mail-intake)
|
||||
* **CI:** Builds and publishes tagged releases, gated on black / ruff / mypy / pytest.
|
||||
|
||||
---
|
||||
|
||||
© Aetoskia Internal — `mail-intake` 0.0.2
|
||||
22
fetch_emails.py
Normal file
22
fetch_emails.py
Normal file
@@ -0,0 +1,22 @@
|
||||
from mail_intake.ingestion import MailIntakeReader
|
||||
from mail_intake.adapters import MailIntakeGmailAdapter
|
||||
from mail_intake.auth import MailIntakeGoogleAuth
|
||||
from mail_intake.credentials.pickle import PickleCredentialStore
|
||||
|
||||
store = PickleCredentialStore(path="token.pickle")
|
||||
|
||||
auth = MailIntakeGoogleAuth(
|
||||
credentials_path="credentials.json",
|
||||
store=store,
|
||||
scopes=["https://www.googleapis.com/auth/gmail.readonly"],
|
||||
)
|
||||
auth.get_credentials()
|
||||
|
||||
adapter = MailIntakeGmailAdapter(auth_provider=auth)
|
||||
reader = MailIntakeReader(adapter)
|
||||
|
||||
for message in reader.iter_messages("from:roshnisingh009@gmail.com"):
|
||||
print(message.subject, message.from_email)
|
||||
break
|
||||
|
||||
from pdb import set_trace;set_trace()
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Mail Intake — provider-agnostic, read-only email ingestion framework.
|
||||
|
||||
Mail Intake is a **contract-first library** designed to ingest, parse, and
|
||||
@@ -8,115 +10,133 @@ provider-agnostic domain models.
|
||||
The library is intentionally structured around clear layers, each exposed
|
||||
as a first-class module at the package root:
|
||||
|
||||
- adapters: provider-specific access (e.g. Gmail)
|
||||
- auth: authentication providers and credential lifecycle management
|
||||
- credentials: credential persistence abstractions and implementations
|
||||
- parsers: extraction and normalization of message content
|
||||
- ingestion: orchestration and high-level ingestion workflows
|
||||
- models: canonical, provider-agnostic data representations
|
||||
- config: explicit global configuration
|
||||
- exceptions: library-defined error hierarchy
|
||||
- `adapters`: Provider-specific access (e.g., Gmail).
|
||||
- `auth`: Authentication providers and credential lifecycle management.
|
||||
- `credentials`: Credential persistence abstractions and implementations.
|
||||
- `parsers`: Extraction and normalization of message content.
|
||||
- `ingestion`: Orchestration and high-level ingestion workflows.
|
||||
- `models`: Canonical, provider-agnostic data representations.
|
||||
- `config`: Explicit global configuration.
|
||||
- `exceptions`: Library-defined error hierarchy.
|
||||
|
||||
The package root acts as a **namespace**, not a facade. Consumers are
|
||||
expected to import functionality explicitly from the appropriate module.
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Installation
|
||||
----------------------------------------------------------------------
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
Install using pip:
|
||||
|
||||
pip install mail-intake
|
||||
```bash
|
||||
pip install mail-intake
|
||||
```
|
||||
|
||||
Or with Poetry:
|
||||
|
||||
poetry add mail-intake
|
||||
```bash
|
||||
poetry add mail-intake
|
||||
```
|
||||
|
||||
Mail Intake is pure Python and has no runtime dependencies beyond those
|
||||
required by the selected provider (for example, Google APIs for Gmail).
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Basic Usage
|
||||
----------------------------------------------------------------------
|
||||
---
|
||||
|
||||
# Quick Start
|
||||
|
||||
Minimal Gmail ingestion example (local development):
|
||||
|
||||
from mail_intake.ingestion import MailIntakeReader
|
||||
from mail_intake.adapters import MailIntakeGmailAdapter
|
||||
from mail_intake.auth import MailIntakeGoogleAuth
|
||||
from mail_intake.credentials import PickleCredentialStore
|
||||
```python
|
||||
from mail_intake.ingestion import MailIntakeReader
|
||||
from mail_intake.adapters import MailIntakeGmailAdapter
|
||||
from mail_intake.auth import MailIntakeGoogleAuth
|
||||
from mail_intake.credentials import PickleCredentialStore
|
||||
|
||||
store = PickleCredentialStore(path="token.pickle")
|
||||
store = PickleCredentialStore(path="token.pickle")
|
||||
|
||||
auth = MailIntakeGoogleAuth(
|
||||
credentials_path="credentials.json",
|
||||
store=store,
|
||||
scopes=["https://www.googleapis.com/auth/gmail.readonly"],
|
||||
)
|
||||
auth = MailIntakeGoogleAuth(
|
||||
credentials_path="credentials.json",
|
||||
store=store,
|
||||
scopes=["https://www.googleapis.com/auth/gmail.readonly"],
|
||||
)
|
||||
|
||||
adapter = MailIntakeGmailAdapter(auth_provider=auth)
|
||||
reader = MailIntakeReader(adapter)
|
||||
adapter = MailIntakeGmailAdapter(auth_provider=auth)
|
||||
reader = MailIntakeReader(adapter)
|
||||
|
||||
for message in reader.iter_messages("from:recruiter@example.com"):
|
||||
print(message.subject, message.from_email)
|
||||
for message in reader.iter_messages("from:recruiter@example.com"):
|
||||
print(message.subject, message.from_email)
|
||||
```
|
||||
|
||||
Iterating over threads:
|
||||
|
||||
for thread in reader.iter_threads("subject:Interview"):
|
||||
print(thread.normalized_subject, len(thread.messages))
|
||||
```python
|
||||
for thread in reader.iter_threads("subject:Interview"):
|
||||
print(thread.normalized_subject, len(thread.messages))
|
||||
```
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Extensibility Model
|
||||
----------------------------------------------------------------------
|
||||
---
|
||||
|
||||
# Architecture
|
||||
|
||||
Mail Intake is designed to be extensible via **public contracts** exposed
|
||||
through its modules:
|
||||
|
||||
- Users MAY implement their own mail adapters by subclassing
|
||||
``adapters.MailIntakeAdapter``
|
||||
`adapters.MailIntakeAdapter`.
|
||||
- Users MAY implement their own authentication providers by subclassing
|
||||
``auth.MailIntakeAuthProvider[T]``
|
||||
- Users MAY implement their own credential persistence layers by
|
||||
implementing ``credentials.CredentialStore[T]``
|
||||
`auth.MailIntakeAuthProvider[T]`.
|
||||
- Users MAY implement their own credential persistence layers by implementing
|
||||
`credentials.CredentialStore[T]`.
|
||||
|
||||
Users SHOULD NOT subclass built-in adapter implementations. Built-in
|
||||
adapters (such as Gmail) are reference implementations and may change
|
||||
internally without notice.
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Public API Surface
|
||||
----------------------------------------------------------------------
|
||||
**Design Guarantees:**
|
||||
|
||||
- Read-only access: no mutation of provider state.
|
||||
- Provider-agnostic domain models.
|
||||
- Explicit configuration and dependency injection.
|
||||
- No implicit global state or environment reads.
|
||||
- Deterministic, testable behavior.
|
||||
- Distributed-safe authentication design.
|
||||
|
||||
Mail Intake favors correctness, clarity, and explicitness over convenience
|
||||
shortcuts.
|
||||
|
||||
**Core Philosophy:**
|
||||
|
||||
`Mail Intake` is built as a **contract-first ingestion pipeline**:
|
||||
|
||||
1. **Layered Decoupling**: Adapters handle transport, Parsers handle format
|
||||
normalization, and Ingestion orchestrates.
|
||||
2. **Provider Agnosticism**: Domain models and core logic never depend on
|
||||
provider-specific (e.g., Gmail) API internals.
|
||||
3. **Stateless Workflows**: The library functions as a read-only pipe, ensuring
|
||||
side-effect-free ingestion.
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
The supported public API consists of the following top-level modules:
|
||||
|
||||
- mail_intake.ingestion
|
||||
- mail_intake.adapters
|
||||
- mail_intake.auth
|
||||
- mail_intake.credentials
|
||||
- mail_intake.parsers
|
||||
- mail_intake.models
|
||||
- mail_intake.config
|
||||
- mail_intake.exceptions
|
||||
- `mail_intake.ingestion`
|
||||
- `mail_intake.adapters`
|
||||
- `mail_intake.auth`
|
||||
- `mail_intake.credentials`
|
||||
- `mail_intake.parsers`
|
||||
- `mail_intake.models`
|
||||
- `mail_intake.config`
|
||||
- `mail_intake.exceptions`
|
||||
|
||||
Classes and functions should be imported explicitly from these modules.
|
||||
No individual symbols are re-exported at the package root.
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Design Guarantees
|
||||
----------------------------------------------------------------------
|
||||
|
||||
- Read-only access: no mutation of provider state
|
||||
- Provider-agnostic domain models
|
||||
- Explicit configuration and dependency injection
|
||||
- No implicit global state or environment reads
|
||||
- Deterministic, testable behavior
|
||||
- Distributed-safe authentication design
|
||||
|
||||
Mail Intake favors correctness, clarity, and explicitness over convenience
|
||||
shortcuts.
|
||||
---
|
||||
"""
|
||||
|
||||
|
||||
from . import ingestion
|
||||
from . import adapters
|
||||
from . import auth
|
||||
|
||||
11
mail_intake/__init__.pyi
Normal file
11
mail_intake/__init__.pyi
Normal file
@@ -0,0 +1,11 @@
|
||||
from . import adapters, auth, config, credentials, exceptions, ingestion, models
|
||||
|
||||
__all__ = [
|
||||
"ingestion",
|
||||
"adapters",
|
||||
"auth",
|
||||
"credentials",
|
||||
"models",
|
||||
"config",
|
||||
"exceptions",
|
||||
]
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Mail provider adapter implementations for Mail Intake.
|
||||
|
||||
This package contains **adapter-layer implementations** responsible for
|
||||
@@ -6,17 +8,24 @@ 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
|
||||
components.
|
||||
|
||||
Public adapters exported from this package are considered the supported
|
||||
integration surface for mail providers.
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
- `MailIntakeAdapter`
|
||||
- `MailIntakeGmailAdapter`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from .base import MailIntakeAdapter
|
||||
|
||||
4
mail_intake/adapters/__init__.pyi
Normal file
4
mail_intake/adapters/__init__.pyi
Normal file
@@ -0,0 +1,4 @@
|
||||
from .base import MailIntakeAdapter
|
||||
from .gmail import MailIntakeGmailAdapter
|
||||
|
||||
__all__ = ["MailIntakeAdapter", "MailIntakeGmailAdapter"]
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Mail provider adapter contracts for Mail Intake.
|
||||
|
||||
This module defines the **provider-agnostic adapter interface** used for
|
||||
@@ -10,67 +12,87 @@ types or semantics should leak beyond implementations of this interface.
|
||||
"""
|
||||
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Iterator, Dict, Any
|
||||
from collections.abc import Iterator
|
||||
from typing import Any
|
||||
|
||||
|
||||
class MailIntakeAdapter(ABC):
|
||||
"""
|
||||
Base adapter interface for mail providers.
|
||||
|
||||
This interface defines the minimal contract required to:
|
||||
- Discover messages matching a query
|
||||
- Retrieve full message payloads
|
||||
- Retrieve full thread payloads
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
Adapters are intentionally read-only and must not mutate provider state.
|
||||
- Discover messages matching a query.
|
||||
- Retrieve full message payloads.
|
||||
- Retrieve full thread payloads.
|
||||
|
||||
**Lifecycle:**
|
||||
|
||||
- Adapters are intentionally read-only and must not mutate provider state.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def iter_message_refs(self, query: str) -> Iterator[Dict[str, str]]:
|
||||
def iter_message_refs(self, query: str) -> Iterator[dict[str, str]]:
|
||||
"""
|
||||
Iterate over lightweight message references matching a query.
|
||||
|
||||
Implementations must yield dictionaries containing at least:
|
||||
- ``message_id``: Provider-specific message identifier
|
||||
- ``thread_id``: Provider-specific thread identifier
|
||||
|
||||
Args:
|
||||
query: Provider-specific query string used to filter messages.
|
||||
query (str):
|
||||
Provider-specific query string used to filter messages.
|
||||
|
||||
Returns:
|
||||
Iterator[dict[str, str]]:
|
||||
An iterator over lightweight message reference dictionaries.
|
||||
|
||||
Yields:
|
||||
Dictionaries containing message and thread identifiers.
|
||||
dict[str, str]:
|
||||
Dictionaries containing message and thread identifiers.
|
||||
|
||||
Example yield:
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
- Implementations must yield dictionaries containing at least
|
||||
`message_id` and `thread_id`.
|
||||
|
||||
Example:
|
||||
Typical yield:
|
||||
|
||||
```python
|
||||
{
|
||||
"message_id": "...",
|
||||
"thread_id": "..."
|
||||
}
|
||||
```
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
@abstractmethod
|
||||
def fetch_message(self, message_id: str) -> Dict[str, Any]:
|
||||
def fetch_message(self, message_id: str) -> dict[str, Any]:
|
||||
"""
|
||||
Fetch a full raw message by message identifier.
|
||||
|
||||
Args:
|
||||
message_id: Provider-specific message identifier.
|
||||
message_id (str):
|
||||
Provider-specific message identifier.
|
||||
|
||||
Returns:
|
||||
Provider-native message payload
|
||||
(e.g., Gmail message JSON structure).
|
||||
dict[str, Any]:
|
||||
Provider-native message payload (e.g., Gmail message JSON structure).
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
@abstractmethod
|
||||
def fetch_thread(self, thread_id: str) -> Dict[str, Any]:
|
||||
def fetch_thread(self, thread_id: str) -> dict[str, Any]:
|
||||
"""
|
||||
Fetch a full raw thread by thread identifier.
|
||||
|
||||
Args:
|
||||
thread_id: Provider-specific thread identifier.
|
||||
thread_id (str):
|
||||
Provider-specific thread identifier.
|
||||
|
||||
Returns:
|
||||
Provider-native thread payload.
|
||||
dict[str, Any]:
|
||||
Provider-native thread payload.
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
11
mail_intake/adapters/base.pyi
Normal file
11
mail_intake/adapters/base.pyi
Normal file
@@ -0,0 +1,11 @@
|
||||
from abc import ABC, abstractmethod
|
||||
from collections.abc import Iterator
|
||||
from typing import Any
|
||||
|
||||
class MailIntakeAdapter(ABC):
|
||||
@abstractmethod
|
||||
def iter_message_refs(self, query: str) -> Iterator[dict[str, str]]: ...
|
||||
@abstractmethod
|
||||
def fetch_message(self, message_id: str) -> dict[str, Any]: ...
|
||||
@abstractmethod
|
||||
def fetch_thread(self, thread_id: str) -> dict[str, Any]: ...
|
||||
@@ -1,25 +1,29 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Gmail adapter implementation for Mail Intake.
|
||||
|
||||
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.
|
||||
"""
|
||||
|
||||
from typing import Iterator, Dict, Any
|
||||
from collections.abc import Iterator
|
||||
from typing import Any
|
||||
|
||||
from googleapiclient.discovery import build
|
||||
from googleapiclient.errors import HttpError
|
||||
|
||||
from mail_intake.adapters.base import MailIntakeAdapter
|
||||
from mail_intake.exceptions import MailIntakeAdapterError
|
||||
from mail_intake.auth.base import MailIntakeAuthProvider
|
||||
from mail_intake.exceptions import MailIntakeAdapterError
|
||||
|
||||
|
||||
class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
@@ -30,15 +34,18 @@ class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
Gmail REST API. It translates the generic mail intake contract into
|
||||
Gmail-specific API calls.
|
||||
|
||||
This class is the ONLY place where:
|
||||
- googleapiclient is imported
|
||||
- Gmail REST semantics are known
|
||||
- .execute() is called
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
Design constraints:
|
||||
- Must remain thin and imperative
|
||||
- Must not perform parsing or interpretation
|
||||
- Must not expose Gmail-specific types beyond this class
|
||||
- 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.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
@@ -50,9 +57,11 @@ class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
Initialize the Gmail adapter.
|
||||
|
||||
Args:
|
||||
auth_provider: Authentication provider capable of supplying
|
||||
valid Gmail API credentials.
|
||||
user_id: Gmail user identifier. Defaults to `"me"`.
|
||||
auth_provider (MailIntakeAuthProvider):
|
||||
Authentication provider capable of supplying valid Gmail API credentials.
|
||||
|
||||
user_id (str):
|
||||
Gmail user identifier. Defaults to `"me"`.
|
||||
"""
|
||||
self._auth_provider = auth_provider
|
||||
self._user_id = user_id
|
||||
@@ -63,11 +72,9 @@ class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
"""
|
||||
Lazily initialize and return the Gmail API service client.
|
||||
|
||||
Returns:
|
||||
Initialized Gmail API service instance.
|
||||
|
||||
Raises:
|
||||
MailIntakeAdapterError: If the Gmail service cannot be initialized.
|
||||
MailIntakeAdapterError:
|
||||
If the Gmail service cannot be initialized.
|
||||
"""
|
||||
if self._service is None:
|
||||
try:
|
||||
@@ -79,26 +86,25 @@ class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
) from exc
|
||||
return self._service
|
||||
|
||||
def iter_message_refs(self, query: str) -> Iterator[Dict[str, str]]:
|
||||
def iter_message_refs(self, query: str) -> Iterator[dict[str, str]]:
|
||||
"""
|
||||
Iterate over message references matching the query.
|
||||
|
||||
Args:
|
||||
query: Gmail search query string.
|
||||
query (str):
|
||||
Gmail search query string.
|
||||
|
||||
Yields:
|
||||
Dictionaries containing:
|
||||
- ``message_id``: Gmail message ID
|
||||
- ``thread_id``: Gmail thread ID
|
||||
dict[str, str]:
|
||||
Dictionaries containing ``message_id`` and ``thread_id``.
|
||||
|
||||
Raises:
|
||||
MailIntakeAdapterError: If the Gmail API returns an error.
|
||||
MailIntakeAdapterError:
|
||||
If the Gmail API returns an error.
|
||||
"""
|
||||
try:
|
||||
request = (
|
||||
self.service.users()
|
||||
.messages()
|
||||
.list(userId=self._user_id, q=query)
|
||||
self.service.users().messages().list(userId=self._user_id, q=query)
|
||||
)
|
||||
|
||||
while request is not None:
|
||||
@@ -110,29 +116,28 @@ class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
"thread_id": msg["threadId"],
|
||||
}
|
||||
|
||||
request = (
|
||||
self.service.users()
|
||||
.messages()
|
||||
.list_next(request, response)
|
||||
)
|
||||
request = self.service.users().messages().list_next(request, response)
|
||||
|
||||
except HttpError as exc:
|
||||
raise MailIntakeAdapterError(
|
||||
"Gmail API error while listing messages"
|
||||
) from exc
|
||||
|
||||
def fetch_message(self, message_id: str) -> Dict[str, Any]:
|
||||
def fetch_message(self, message_id: str) -> dict[str, Any]:
|
||||
"""
|
||||
Fetch a full Gmail message by message ID.
|
||||
|
||||
Args:
|
||||
message_id: Gmail message identifier.
|
||||
message_id (str):
|
||||
Gmail message identifier.
|
||||
|
||||
Returns:
|
||||
Provider-native Gmail message payload.
|
||||
dict[str, Any]:
|
||||
Provider-native Gmail message payload.
|
||||
|
||||
Raises:
|
||||
MailIntakeAdapterError: If the Gmail API returns an error.
|
||||
MailIntakeAdapterError:
|
||||
If the Gmail API returns an error.
|
||||
"""
|
||||
try:
|
||||
return (
|
||||
@@ -146,18 +151,21 @@ class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
f"Gmail API error while fetching message {message_id}"
|
||||
) from exc
|
||||
|
||||
def fetch_thread(self, thread_id: str) -> Dict[str, Any]:
|
||||
def fetch_thread(self, thread_id: str) -> dict[str, Any]:
|
||||
"""
|
||||
Fetch a full Gmail thread by thread ID.
|
||||
|
||||
Args:
|
||||
thread_id: Gmail thread identifier.
|
||||
thread_id (str):
|
||||
Gmail thread identifier.
|
||||
|
||||
Returns:
|
||||
Provider-native Gmail thread payload.
|
||||
dict[str, Any]:
|
||||
Provider-native Gmail thread payload.
|
||||
|
||||
Raises:
|
||||
MailIntakeAdapterError: If the Gmail API returns an error.
|
||||
MailIntakeAdapterError:
|
||||
If the Gmail API returns an error.
|
||||
"""
|
||||
try:
|
||||
return (
|
||||
|
||||
15
mail_intake/adapters/gmail.pyi
Normal file
15
mail_intake/adapters/gmail.pyi
Normal file
@@ -0,0 +1,15 @@
|
||||
from collections.abc import Iterator
|
||||
from typing import Any
|
||||
|
||||
from mail_intake.adapters.base import MailIntakeAdapter
|
||||
from mail_intake.auth.base import MailIntakeAuthProvider
|
||||
|
||||
class MailIntakeGmailAdapter(MailIntakeAdapter):
|
||||
def __init__(
|
||||
self, auth_provider: MailIntakeAuthProvider[Any], user_id: str = ...
|
||||
) -> None: ...
|
||||
@property
|
||||
def service(self) -> Any: ...
|
||||
def iter_message_refs(self, query: str) -> Iterator[dict[str, str]]: ...
|
||||
def fetch_message(self, message_id: str) -> dict[str, Any]: ...
|
||||
def fetch_thread(self, thread_id: str) -> dict[str, Any]: ...
|
||||
@@ -1,20 +1,33 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Authentication provider implementations for Mail Intake.
|
||||
|
||||
This package defines the **authentication layer** used by mail adapters
|
||||
to obtain provider-specific credentials.
|
||||
|
||||
It exposes:
|
||||
- A stable, provider-agnostic authentication contract
|
||||
- Concrete authentication providers for supported platforms
|
||||
|
||||
- A stable, provider-agnostic authentication contract.
|
||||
- Concrete authentication providers for supported platforms.
|
||||
|
||||
Authentication providers:
|
||||
- Are responsible for credential acquisition and lifecycle management
|
||||
- Are intentionally decoupled from adapter logic
|
||||
- May be extended by users to support additional providers
|
||||
|
||||
- Are responsible for credential acquisition and lifecycle management.
|
||||
- Are intentionally decoupled from adapter logic.
|
||||
- May be extended by users to support additional providers.
|
||||
|
||||
Consumers should depend on the abstract interface and use concrete
|
||||
implementations only where explicitly required.
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
- `MailIntakeAuthProvider`
|
||||
- `MailIntakeGoogleAuth`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from .base import MailIntakeAuthProvider
|
||||
|
||||
4
mail_intake/auth/__init__.pyi
Normal file
4
mail_intake/auth/__init__.pyi
Normal file
@@ -0,0 +1,4 @@
|
||||
from .base import MailIntakeAuthProvider
|
||||
from .google import MailIntakeGoogleAuth
|
||||
|
||||
__all__ = ["MailIntakeAuthProvider", "MailIntakeGoogleAuth"]
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Authentication provider contracts for Mail Intake.
|
||||
|
||||
This module defines the **authentication abstraction layer** used by mail
|
||||
@@ -23,15 +25,20 @@ class MailIntakeAuthProvider(ABC, Generic[T]):
|
||||
providers and mail adapters by requiring providers to explicitly
|
||||
declare the type of credentials they return.
|
||||
|
||||
Authentication providers encapsulate all logic required to:
|
||||
- Acquire credentials from an external provider
|
||||
- Refresh or revalidate credentials as needed
|
||||
- Handle authentication-specific failure modes
|
||||
- Coordinate with credential persistence layers where applicable
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
Mail adapters must treat returned credentials as opaque and
|
||||
provider-specific, relying only on the declared credential type
|
||||
expected by the adapter.
|
||||
- Acquire credentials from an external provider.
|
||||
- Refresh or revalidate credentials as needed.
|
||||
- Handle authentication-specific failure modes.
|
||||
- Coordinate with credential persistence layers where applicable.
|
||||
|
||||
**Constraints:**
|
||||
|
||||
- Mail adapters must treat returned credentials as opaque and
|
||||
provider-specific.
|
||||
- Mail adapters rely only on the declared credential type expected
|
||||
by the adapter.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
@@ -39,21 +46,23 @@ class MailIntakeAuthProvider(ABC, Generic[T]):
|
||||
"""
|
||||
Retrieve valid, provider-specific credentials.
|
||||
|
||||
This method is synchronous by design and represents the sole
|
||||
entry point through which adapters obtain authentication
|
||||
material.
|
||||
|
||||
Implementations must either return credentials of the declared
|
||||
type ``T`` that are valid at the time of return or raise an
|
||||
authentication-specific exception.
|
||||
|
||||
Returns:
|
||||
Credentials of type ``T`` suitable for immediate use by the
|
||||
corresponding mail adapter.
|
||||
T:
|
||||
Credentials of type `T` suitable for immediate use by the
|
||||
corresponding mail adapter.
|
||||
|
||||
Raises:
|
||||
Exception:
|
||||
An authentication-specific exception indicating that
|
||||
credentials could not be obtained or validated.
|
||||
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
- This method is synchronous by design.
|
||||
- Represents the sole entry point through which adapters obtain
|
||||
authentication material.
|
||||
- Implementations must either return credentials of the declared
|
||||
type `T` that are valid at the time of return or raise an exception.
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
8
mail_intake/auth/base.pyi
Normal file
8
mail_intake/auth/base.pyi
Normal file
@@ -0,0 +1,8 @@
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Generic, TypeVar
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
class MailIntakeAuthProvider(ABC, Generic[T]):
|
||||
@abstractmethod
|
||||
def get_credentials(self) -> T: ...
|
||||
@@ -1,25 +1,28 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Google authentication provider implementation for Mail Intake.
|
||||
|
||||
This module provides a **Google OAuth–based authentication provider**
|
||||
used primarily for Gmail access.
|
||||
|
||||
It encapsulates all Google-specific authentication concerns, including:
|
||||
- Credential loading and persistence
|
||||
- Token refresh handling
|
||||
- Interactive OAuth flow initiation
|
||||
- Coordination with a credential persistence layer
|
||||
|
||||
- Credential loading and persistence.
|
||||
- Token refresh handling.
|
||||
- Interactive OAuth flow initiation.
|
||||
- Coordination with a credential persistence layer.
|
||||
|
||||
No Google authentication details should leak outside this module.
|
||||
"""
|
||||
|
||||
import os
|
||||
from typing import Sequence
|
||||
from collections.abc import Sequence
|
||||
|
||||
import google.auth.exceptions
|
||||
from google.auth.transport.requests import Request
|
||||
from google_auth_oauthlib.flow import InstalledAppFlow
|
||||
from google.oauth2.credentials import Credentials
|
||||
from google_auth_oauthlib.flow import InstalledAppFlow
|
||||
|
||||
from mail_intake.auth.base import MailIntakeAuthProvider
|
||||
from mail_intake.credentials.store import CredentialStore
|
||||
@@ -33,13 +36,18 @@ class MailIntakeGoogleAuth(MailIntakeAuthProvider):
|
||||
This provider implements the `MailIntakeAuthProvider` interface using
|
||||
Google's OAuth 2.0 flow and credential management libraries.
|
||||
|
||||
Responsibilities:
|
||||
- Load cached credentials from a credential store when available
|
||||
- Refresh expired credentials when possible
|
||||
- Initiate an interactive OAuth flow only when required
|
||||
- Persist refreshed or newly obtained credentials via the store
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
This class is synchronous by design and maintains a minimal internal state.
|
||||
- Load cached credentials from a credential store when available.
|
||||
- Refresh expired credentials when possible.
|
||||
- Initiate an interactive OAuth flow only when required.
|
||||
- Persist refreshed or newly obtained credentials via the store.
|
||||
|
||||
**Guarantees:**
|
||||
|
||||
- This class is synchronous by design and maintains a minimal
|
||||
internal state.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
@@ -52,15 +60,13 @@ class MailIntakeGoogleAuth(MailIntakeAuthProvider):
|
||||
Initialize the Google authentication provider.
|
||||
|
||||
Args:
|
||||
credentials_path:
|
||||
Path to the Google OAuth client secrets file used to
|
||||
initiate the OAuth 2.0 flow.
|
||||
credentials_path (str):
|
||||
Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
|
||||
|
||||
store:
|
||||
Credential store responsible for persisting and
|
||||
retrieving Google OAuth credentials.
|
||||
store (CredentialStore[Credentials]):
|
||||
Credential store responsible for persisting and retrieving Google OAuth credentials.
|
||||
|
||||
scopes:
|
||||
scopes (Sequence[str]):
|
||||
OAuth scopes required for Gmail access.
|
||||
"""
|
||||
self.credentials_path = credentials_path
|
||||
@@ -71,19 +77,23 @@ class MailIntakeGoogleAuth(MailIntakeAuthProvider):
|
||||
"""
|
||||
Retrieve valid Google OAuth credentials.
|
||||
|
||||
This method attempts to:
|
||||
1. Load cached credentials from the configured credential store
|
||||
2. Refresh expired credentials when possible
|
||||
3. Perform an interactive OAuth login as a fallback
|
||||
4. Persist valid credentials for future use
|
||||
|
||||
Returns:
|
||||
A ``google.oauth2.credentials.Credentials`` instance suitable
|
||||
for use with Google API clients.
|
||||
Credentials:
|
||||
A `google.oauth2.credentials.Credentials` instance suitable
|
||||
for use with Google API clients.
|
||||
|
||||
Raises:
|
||||
MailIntakeAuthError: If credentials cannot be loaded, refreshed,
|
||||
MailIntakeAuthError:
|
||||
If credentials cannot be loaded, refreshed,
|
||||
or obtained via interactive authentication.
|
||||
|
||||
Notes:
|
||||
**Lifecycle:**
|
||||
|
||||
- Load cached credentials from the configured credential store.
|
||||
- Refresh expired credentials when possible.
|
||||
- Perform an interactive OAuth login as a fallback.
|
||||
- Persist valid credentials for future use.
|
||||
"""
|
||||
creds = self.store.load()
|
||||
|
||||
|
||||
11
mail_intake/auth/google.pyi
Normal file
11
mail_intake/auth/google.pyi
Normal file
@@ -0,0 +1,11 @@
|
||||
from collections.abc import Sequence
|
||||
from typing import Any
|
||||
|
||||
from mail_intake.auth.base import MailIntakeAuthProvider
|
||||
from mail_intake.credentials.store import CredentialStore
|
||||
|
||||
class MailIntakeGoogleAuth(MailIntakeAuthProvider[Any]):
|
||||
def __init__(
|
||||
self, credentials_path: str, store: CredentialStore[Any], scopes: Sequence[str]
|
||||
) -> None: ...
|
||||
def get_credentials(self) -> Any: ...
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Global configuration models for Mail Intake.
|
||||
|
||||
This module defines the **top-level configuration object** used to control
|
||||
@@ -10,36 +12,45 @@ environment reads to ensure predictability and testability.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass
|
||||
from typing import Optional
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class MailIntakeConfig:
|
||||
"""
|
||||
Global configuration for mail-intake.
|
||||
Global configuration for `mail-intake`.
|
||||
|
||||
This configuration is intentionally explicit and immutable.
|
||||
No implicit environment reads or global state.
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
Design principles:
|
||||
- Immutable once constructed
|
||||
- Explicit configuration over implicit defaults
|
||||
- No direct environment or filesystem access
|
||||
|
||||
This model is safe to pass across layers and suitable for serialization.
|
||||
- This configuration is intentionally explicit and immutable.
|
||||
- No implicit environment reads or global state.
|
||||
- Explicit configuration over implicit defaults.
|
||||
- No direct environment or filesystem access.
|
||||
- This model is safe to pass across layers and suitable for
|
||||
serialization.
|
||||
"""
|
||||
|
||||
provider: str = "gmail"
|
||||
"""Identifier of the mail provider to use (e.g., ``"gmail"``)."""
|
||||
"""
|
||||
Identifier of the mail provider to use (e.g., ``"gmail"``).
|
||||
"""
|
||||
|
||||
user_id: str = "me"
|
||||
"""Provider-specific user identifier. Defaults to the authenticated user."""
|
||||
"""
|
||||
Provider-specific user identifier. Defaults to the authenticated user.
|
||||
"""
|
||||
|
||||
readonly: bool = True
|
||||
"""Whether ingestion should operate in read-only mode."""
|
||||
"""
|
||||
Whether ingestion should operate in read-only mode.
|
||||
"""
|
||||
|
||||
credentials_path: Optional[str] = None
|
||||
"""Optional path to provider credentials configuration."""
|
||||
credentials_path: str | None = None
|
||||
"""
|
||||
Optional path to provider credentials configuration.
|
||||
"""
|
||||
|
||||
token_path: Optional[str] = None
|
||||
"""Optional path to persisted authentication tokens."""
|
||||
token_path: str | None = None
|
||||
"""
|
||||
Optional path to persisted authentication tokens.
|
||||
"""
|
||||
|
||||
14
mail_intake/config.pyi
Normal file
14
mail_intake/config.pyi
Normal file
@@ -0,0 +1,14 @@
|
||||
class MailIntakeConfig:
|
||||
provider: str
|
||||
user_id: str
|
||||
readonly: bool
|
||||
credentials_path: str | None
|
||||
token_path: str | None
|
||||
def __init__(
|
||||
self,
|
||||
provider: str = ...,
|
||||
user_id: str = ...,
|
||||
readonly: bool = ...,
|
||||
credentials_path: str | None = ...,
|
||||
token_path: str | None = ...,
|
||||
) -> None: ...
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Credential persistence interfaces and implementations for Mail Intake.
|
||||
|
||||
This package defines the abstractions and concrete implementations used
|
||||
@@ -10,12 +12,23 @@ credential acquisition, validation, and refresh, while implementations
|
||||
within this package are responsible solely for storage and retrieval.
|
||||
|
||||
The package provides:
|
||||
- A generic ``CredentialStore`` abstraction defining the persistence contract
|
||||
- Local filesystem–based storage for development and single-node use
|
||||
- Distributed, Redis-backed storage for production and scaled deployments
|
||||
|
||||
- A generic `CredentialStore` abstraction defining the persistence contract.
|
||||
- Local filesystem–based storage for development and single-node use.
|
||||
- Distributed, Redis-backed storage for production and scaled deployments.
|
||||
|
||||
Credential lifecycle management, interpretation, and security policy
|
||||
decisions remain the responsibility of authentication providers.
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
- `CredentialStore`
|
||||
- `PickleCredentialStore`
|
||||
- `RedisCredentialStore`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from mail_intake.credentials.store import CredentialStore
|
||||
|
||||
5
mail_intake/credentials/__init__.pyi
Normal file
5
mail_intake/credentials/__init__.pyi
Normal file
@@ -0,0 +1,5 @@
|
||||
from .pickle import PickleCredentialStore
|
||||
from .redis import RedisCredentialStore
|
||||
from .store import CredentialStore
|
||||
|
||||
__all__ = ["CredentialStore", "PickleCredentialStore", "RedisCredentialStore"]
|
||||
@@ -1,20 +1,22 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Local filesystem–based credential persistence for Mail Intake.
|
||||
|
||||
This module provides a file-backed implementation of the
|
||||
``CredentialStore`` abstraction using Python's ``pickle`` module.
|
||||
`CredentialStore` abstraction using Python's `pickle` module.
|
||||
|
||||
The pickle-based credential store is intended for local development,
|
||||
The `pickle`-based credential store is intended for local development,
|
||||
single-node deployments, and controlled environments where credentials
|
||||
do not need to be shared across processes or machines.
|
||||
|
||||
Due to the security and portability risks associated with pickle-based
|
||||
Due to the security and portability risks associated with `pickle`-based
|
||||
serialization, this implementation is not suitable for distributed or
|
||||
untrusted environments.
|
||||
"""
|
||||
|
||||
import pickle
|
||||
from typing import Optional, TypeVar
|
||||
from typing import TypeVar
|
||||
|
||||
from mail_intake.credentials.store import CredentialStore
|
||||
|
||||
@@ -29,13 +31,17 @@ class PickleCredentialStore(CredentialStore[T]):
|
||||
filesystem. It is a simple implementation intended primarily for
|
||||
development, testing, and single-process execution contexts.
|
||||
|
||||
This implementation:
|
||||
- Stores credentials on the local filesystem
|
||||
- Uses pickle for serialization and deserialization
|
||||
- Does not provide encryption, locking, or concurrency guarantees
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
Credential lifecycle management, validation, and refresh logic are
|
||||
explicitly out of scope for this class.
|
||||
- Stores credentials on the local filesystem.
|
||||
- Uses `pickle` for serialization and deserialization.
|
||||
- Does not provide encryption, locking, or concurrency guarantees.
|
||||
|
||||
**Constraints:**
|
||||
|
||||
- Credential lifecycle management, validation, and refresh logic are
|
||||
explicitly out of scope for this class.
|
||||
"""
|
||||
|
||||
def __init__(self, path: str):
|
||||
@@ -43,25 +49,28 @@ class PickleCredentialStore(CredentialStore[T]):
|
||||
Initialize a pickle-backed credential store.
|
||||
|
||||
Args:
|
||||
path:
|
||||
path (str):
|
||||
Filesystem path where credentials will be stored.
|
||||
The file will be created or overwritten as needed.
|
||||
"""
|
||||
self.path = path
|
||||
|
||||
def load(self) -> Optional[T]:
|
||||
def load(self) -> T | None:
|
||||
"""
|
||||
Load credentials from the local filesystem.
|
||||
|
||||
If the credential file does not exist or cannot be successfully
|
||||
deserialized, this method returns ``None``.
|
||||
|
||||
The store does not attempt to validate or interpret the returned
|
||||
credentials.
|
||||
|
||||
Returns:
|
||||
An instance of type ``T`` if credentials are present and
|
||||
successfully deserialized; otherwise ``None``.
|
||||
T | None:
|
||||
An instance of type `T` if credentials are present and
|
||||
successfully deserialized; otherwise `None`.
|
||||
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
- If the credential file does not exist or cannot be successfully
|
||||
deserialized, this method returns `None`.
|
||||
- The store does not attempt to validate or interpret the
|
||||
returned credentials.
|
||||
"""
|
||||
try:
|
||||
with open(self.path, "rb") as fh:
|
||||
@@ -73,12 +82,14 @@ class PickleCredentialStore(CredentialStore[T]):
|
||||
"""
|
||||
Persist credentials to the local filesystem.
|
||||
|
||||
Any previously stored credentials at the configured path are
|
||||
overwritten.
|
||||
|
||||
Args:
|
||||
credentials:
|
||||
credentials (T):
|
||||
The credential object to persist.
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- Any previously stored credentials at the configured path are overwritten
|
||||
"""
|
||||
with open(self.path, "wb") as fh:
|
||||
pickle.dump(credentials, fh)
|
||||
@@ -87,8 +98,10 @@ class PickleCredentialStore(CredentialStore[T]):
|
||||
"""
|
||||
Remove persisted credentials from the local filesystem.
|
||||
|
||||
This method deletes the credential file if it exists and should
|
||||
be treated as an idempotent operation.
|
||||
Notes:
|
||||
**Lifecycle:**
|
||||
|
||||
- This method deletes the credential file if it exists and should be treated as an idempotent operation
|
||||
"""
|
||||
import os
|
||||
|
||||
|
||||
12
mail_intake/credentials/pickle.pyi
Normal file
12
mail_intake/credentials/pickle.pyi
Normal file
@@ -0,0 +1,12 @@
|
||||
from typing import TypeVar
|
||||
|
||||
from .store import CredentialStore
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
class PickleCredentialStore(CredentialStore[T]):
|
||||
path: str
|
||||
def __init__(self, path: str) -> None: ...
|
||||
def load(self) -> T | None: ...
|
||||
def save(self, credentials: T) -> None: ...
|
||||
def clear(self) -> None: ...
|
||||
@@ -1,8 +1,10 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Redis-backed credential persistence for Mail Intake.
|
||||
|
||||
This module provides a Redis-based implementation of the
|
||||
``CredentialStore`` abstraction, enabling credential persistence
|
||||
`CredentialStore` abstraction, enabling credential persistence
|
||||
across distributed and horizontally scaled deployments.
|
||||
|
||||
The Redis credential store is designed for environments where
|
||||
@@ -11,18 +13,19 @@ processes, containers, or nodes, such as container orchestration
|
||||
platforms and microservice architectures.
|
||||
|
||||
Key characteristics:
|
||||
- Distributed-safe, shared storage using Redis
|
||||
- Explicit, caller-defined serialization and deserialization
|
||||
- No reliance on unsafe mechanisms such as pickle
|
||||
- Optional time-to-live (TTL) support for automatic credential expiry
|
||||
|
||||
- Distributed-safe, shared storage using Redis.
|
||||
- Explicit, caller-defined serialization and deserialization.
|
||||
- No reliance on unsafe mechanisms such as `pickle`.
|
||||
- Optional time-to-live (TTL) support for automatic credential expiry.
|
||||
|
||||
This module is responsible solely for persistence concerns.
|
||||
Credential validation, refresh, rotation, and acquisition remain the
|
||||
responsibility of authentication provider implementations.
|
||||
"""
|
||||
|
||||
|
||||
from typing import Optional, TypeVar, Callable
|
||||
from collections.abc import Callable
|
||||
from typing import Any, TypeVar
|
||||
|
||||
from mail_intake.credentials.store import CredentialStore
|
||||
|
||||
@@ -31,59 +34,50 @@ T = TypeVar("T")
|
||||
|
||||
class RedisCredentialStore(CredentialStore[T]):
|
||||
"""
|
||||
Redis-backed implementation of ``CredentialStore``.
|
||||
Redis-backed implementation of `CredentialStore`.
|
||||
|
||||
This store persists credentials in Redis and is suitable for
|
||||
distributed and horizontally scaled deployments where credentials
|
||||
must be shared across multiple processes or nodes.
|
||||
|
||||
The store is intentionally generic and delegates all serialization
|
||||
concerns to caller-provided functions. This avoids unsafe mechanisms
|
||||
such as pickle and allows credential formats to be explicitly
|
||||
controlled and audited.
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
This class is responsible only for persistence and retrieval.
|
||||
It does not interpret, validate, refresh, or otherwise manage
|
||||
the lifecycle of the credentials being stored.
|
||||
- This class is responsible only for persistence and retrieval.
|
||||
- It does not interpret, validate, refresh, or otherwise manage the
|
||||
lifecycle of the credentials being stored.
|
||||
|
||||
**Guarantees:**
|
||||
|
||||
- The store is intentionally generic and delegates all serialization
|
||||
concerns to caller-provided functions.
|
||||
- This avoids unsafe mechanisms such as `pickle` and allows
|
||||
credential formats to be explicitly controlled and audited.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
redis_client,
|
||||
redis_client: Any,
|
||||
key: str,
|
||||
serialize: Callable[[T], bytes],
|
||||
deserialize: Callable[[bytes], T],
|
||||
ttl_seconds: Optional[int] = None,
|
||||
ttl_seconds: int | None = None,
|
||||
):
|
||||
"""
|
||||
Initialize a Redis-backed credential store.
|
||||
|
||||
Args:
|
||||
redis_client:
|
||||
An initialized Redis client instance (for example,
|
||||
``redis.Redis`` or a compatible interface) used to
|
||||
communicate with the Redis server.
|
||||
|
||||
key:
|
||||
The Redis key under which credentials are stored.
|
||||
Callers are responsible for applying appropriate
|
||||
namespacing to avoid collisions.
|
||||
|
||||
serialize:
|
||||
A callable that converts a credential object of type
|
||||
``T`` into a ``bytes`` representation suitable for
|
||||
storage in Redis.
|
||||
|
||||
deserialize:
|
||||
A callable that converts a ``bytes`` payload retrieved
|
||||
from Redis back into a credential object of type ``T``.
|
||||
|
||||
ttl_seconds:
|
||||
Optional time-to-live (TTL) for the stored credentials,
|
||||
expressed in seconds. When provided, Redis will
|
||||
automatically expire the stored credentials after the
|
||||
specified duration. If ``None``, credentials are stored
|
||||
without an expiration.
|
||||
redis_client (Any):
|
||||
Initialized Redis client instance used for persistence.
|
||||
key (str):
|
||||
Storage key under which credentials are persisted.
|
||||
serialize (Callable[[T], bytes]):
|
||||
Callable that encodes credentials to bytes for storage.
|
||||
deserialize (Callable[[bytes], T]):
|
||||
Callable that decodes stored bytes back into credentials.
|
||||
ttl_seconds (int | None):
|
||||
Optional time-to-live in seconds after which stored
|
||||
credentials expire automatically. ``None`` disables expiry.
|
||||
"""
|
||||
self.redis = redis_client
|
||||
self.key = key
|
||||
@@ -91,20 +85,24 @@ class RedisCredentialStore(CredentialStore[T]):
|
||||
self.deserialize = deserialize
|
||||
self.ttl_seconds = ttl_seconds
|
||||
|
||||
def load(self) -> Optional[T]:
|
||||
def load(self) -> T | None:
|
||||
"""
|
||||
Load credentials from Redis.
|
||||
|
||||
If no value exists for the configured key, or if the stored
|
||||
payload cannot be successfully deserialized, this method
|
||||
returns ``None``.
|
||||
|
||||
The store does not attempt to validate the returned credentials
|
||||
or determine whether they are expired or otherwise usable.
|
||||
|
||||
Returns:
|
||||
An instance of type ``T`` if credentials are present and
|
||||
successfully deserialized; otherwise ``None``.
|
||||
T | None:
|
||||
An instance of type `T` if credentials are present and
|
||||
successfully deserialized; otherwise `None`.
|
||||
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
- If no value exists for the configured key, or if the stored
|
||||
payload cannot be successfully deserialized, this method
|
||||
returns `None`.
|
||||
- The store does not attempt to validate the returned
|
||||
credentials or determine whether they are expired or
|
||||
otherwise usable.
|
||||
"""
|
||||
raw = self.redis.get(self.key)
|
||||
if not raw:
|
||||
@@ -118,13 +116,15 @@ class RedisCredentialStore(CredentialStore[T]):
|
||||
"""
|
||||
Persist credentials to Redis.
|
||||
|
||||
Any previously stored credentials under the same key are
|
||||
overwritten. If a TTL is configured, the credentials will
|
||||
expire automatically after the specified duration.
|
||||
|
||||
Args:
|
||||
credentials:
|
||||
credentials (T):
|
||||
The credential object to persist.
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- Any previously stored credentials under the same key are overwritten
|
||||
- If a TTL is configured, the credentials will expire automatically after the specified duration
|
||||
"""
|
||||
payload = self.serialize(credentials)
|
||||
if self.ttl_seconds:
|
||||
@@ -136,7 +136,10 @@ class RedisCredentialStore(CredentialStore[T]):
|
||||
"""
|
||||
Remove stored credentials from Redis.
|
||||
|
||||
This operation deletes the configured Redis key if it exists.
|
||||
Implementations should treat this method as idempotent.
|
||||
Notes:
|
||||
**Lifecycle:**
|
||||
|
||||
- This operation deletes the configured Redis key if it exists
|
||||
- Implementations should treat this method as idempotent
|
||||
"""
|
||||
self.redis.delete(self.key)
|
||||
|
||||
24
mail_intake/credentials/redis.pyi
Normal file
24
mail_intake/credentials/redis.pyi
Normal file
@@ -0,0 +1,24 @@
|
||||
from collections.abc import Callable
|
||||
from typing import Any, TypeVar
|
||||
|
||||
from .store import CredentialStore
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
class RedisCredentialStore(CredentialStore[T]):
|
||||
redis: Any
|
||||
key: str
|
||||
serialize: Callable[[T], bytes]
|
||||
deserialize: Callable[[bytes], T]
|
||||
ttl_seconds: int | None
|
||||
def __init__(
|
||||
self,
|
||||
redis_client: Any,
|
||||
key: str,
|
||||
serialize: Callable[[T], bytes],
|
||||
deserialize: Callable[[bytes], T],
|
||||
ttl_seconds: int | None = ...,
|
||||
) -> None: ...
|
||||
def load(self) -> T | None: ...
|
||||
def save(self, credentials: T) -> None: ...
|
||||
def clear(self) -> None: ...
|
||||
@@ -1,10 +1,12 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Credential persistence abstractions for Mail Intake.
|
||||
|
||||
This module defines the generic persistence contract used to store and
|
||||
retrieve authentication credentials across Mail Intake components.
|
||||
|
||||
The ``CredentialStore`` abstraction establishes a strict separation
|
||||
The `CredentialStore` abstraction establishes a strict separation
|
||||
between credential *lifecycle management* and credential *storage*.
|
||||
Authentication providers are responsible for acquiring, validating,
|
||||
refreshing, and revoking credentials, while concrete store
|
||||
@@ -17,51 +19,51 @@ or secrets managers—without coupling authentication logic to any
|
||||
specific storage mechanism.
|
||||
"""
|
||||
|
||||
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Generic, Optional, TypeVar
|
||||
from typing import Generic, TypeVar
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
|
||||
class CredentialStore(ABC, Generic[T]):
|
||||
"""
|
||||
Abstract base class defining a generic persistence interface for
|
||||
authentication credentials.
|
||||
Abstract base class defining a generic persistence interface.
|
||||
|
||||
This interface separates *credential lifecycle management* from
|
||||
*credential storage mechanics*. Implementations are responsible
|
||||
only for persistence concerns, while authentication providers
|
||||
retain full control over credential creation, validation, refresh,
|
||||
and revocation logic.
|
||||
Used for authentication credentials across different backends.
|
||||
|
||||
The store is intentionally agnostic to:
|
||||
- The concrete credential type being stored
|
||||
- The serialization format used to persist credentials
|
||||
- The underlying storage backend or durability guarantees
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
Type Parameters:
|
||||
T:
|
||||
The concrete credential type managed by the store. This may
|
||||
represent OAuth credentials, API tokens, session objects,
|
||||
or any other authentication material.
|
||||
- Provide persistent storage separating life-cycle management from
|
||||
storage mechanics.
|
||||
- Keep implementation focused only on persistence.
|
||||
|
||||
**Constraints:**
|
||||
|
||||
- The store is intentionally agnostic to:
|
||||
- The concrete credential type being stored.
|
||||
- The serialization format used to persist credentials.
|
||||
- The underlying storage backend or durability guarantees.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def load(self) -> Optional[T]:
|
||||
def load(self) -> T | None:
|
||||
"""
|
||||
Load previously persisted credentials.
|
||||
|
||||
Implementations should return ``None`` when no credentials are
|
||||
present or when stored credentials cannot be successfully
|
||||
decoded or deserialized.
|
||||
|
||||
The store must not attempt to validate, refresh, or otherwise
|
||||
interpret the returned credentials.
|
||||
|
||||
Returns:
|
||||
An instance of type ``T`` if credentials are available and
|
||||
loadable; otherwise ``None``.
|
||||
T | None:
|
||||
An instance of type `T` if credentials are available and
|
||||
loadable; otherwise `None`.
|
||||
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
- Implementations should return `None` when no credentials are
|
||||
present or when stored credentials cannot be successfully
|
||||
decoded or deserialized.
|
||||
- The store must not attempt to validate, refresh, or otherwise
|
||||
interpret the returned credentials.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
@@ -69,18 +71,20 @@ class CredentialStore(ABC, Generic[T]):
|
||||
"""
|
||||
Persist credentials to the underlying storage backend.
|
||||
|
||||
This method is invoked when credentials are newly obtained or
|
||||
have been refreshed and are known to be valid at the time of
|
||||
persistence.
|
||||
|
||||
Implementations are responsible for:
|
||||
- Ensuring durability appropriate to the deployment context
|
||||
- Applying encryption or access controls where required
|
||||
- Overwriting any previously stored credentials
|
||||
|
||||
Args:
|
||||
credentials:
|
||||
credentials (T):
|
||||
The credential object to persist.
|
||||
|
||||
Notes:
|
||||
**Lifecycle:**
|
||||
|
||||
- This method is invoked when credentials are newly obtained or have been refreshed and are known to be valid at the time of persistence
|
||||
|
||||
**Responsibilities:**
|
||||
|
||||
- Ensuring durability appropriate to the deployment context
|
||||
- Applying encryption or access controls where required
|
||||
- Overwriting any previously stored credentials
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
@@ -88,9 +92,13 @@ class CredentialStore(ABC, Generic[T]):
|
||||
"""
|
||||
Remove any persisted credentials from the store.
|
||||
|
||||
This method is called when credentials are known to be invalid,
|
||||
revoked, corrupted, or otherwise unusable, and must ensure that
|
||||
no stale authentication material remains accessible.
|
||||
Notes:
|
||||
**Lifecycle:**
|
||||
|
||||
Implementations should treat this operation as idempotent.
|
||||
- This method is called when credentials are known to be invalid, revoked, corrupted, or otherwise unusable
|
||||
- Must ensure that no stale authentication material remains accessible
|
||||
|
||||
**Guarantees:**
|
||||
|
||||
- Implementations should treat this operation as idempotent
|
||||
"""
|
||||
|
||||
12
mail_intake/credentials/store.pyi
Normal file
12
mail_intake/credentials/store.pyi
Normal file
@@ -0,0 +1,12 @@
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Generic, TypeVar
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
class CredentialStore(ABC, Generic[T]):
|
||||
@abstractmethod
|
||||
def load(self) -> T | None: ...
|
||||
@abstractmethod
|
||||
def save(self, credentials: T) -> None: ...
|
||||
@abstractmethod
|
||||
def clear(self) -> None: ...
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Exception hierarchy for Mail Intake.
|
||||
|
||||
This module defines the **canonical exception types** used throughout the
|
||||
@@ -14,11 +16,12 @@ class MailIntakeError(Exception):
|
||||
"""
|
||||
Base exception for all Mail Intake errors.
|
||||
|
||||
This is the root of the Mail Intake exception hierarchy.
|
||||
All errors raised by the library must derive from this class.
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
Consumers should generally catch this type when handling
|
||||
library-level failures.
|
||||
- This is the root of the Mail Intake exception hierarchy
|
||||
- All errors raised by the library must derive from this class
|
||||
- Consumers should generally catch this type when handling library-level failures
|
||||
"""
|
||||
|
||||
|
||||
@@ -26,8 +29,11 @@ class MailIntakeAuthError(MailIntakeError):
|
||||
"""
|
||||
Authentication and credential-related failures.
|
||||
|
||||
Raised when authentication providers are unable to acquire,
|
||||
refresh, or persist valid credentials.
|
||||
Notes:
|
||||
**Lifecycle:**
|
||||
|
||||
- Raised when authentication providers are unable to acquire,
|
||||
refresh, or persist valid credentials.
|
||||
"""
|
||||
|
||||
|
||||
@@ -35,8 +41,11 @@ class MailIntakeAdapterError(MailIntakeError):
|
||||
"""
|
||||
Errors raised by mail provider adapters.
|
||||
|
||||
Raised when a provider adapter encounters API errors,
|
||||
transport failures, or invalid provider responses.
|
||||
Notes:
|
||||
**Lifecycle:**
|
||||
|
||||
- Raised when a provider adapter encounters API errors, transport
|
||||
failures, or invalid provider responses.
|
||||
"""
|
||||
|
||||
|
||||
@@ -44,6 +53,9 @@ class MailIntakeParsingError(MailIntakeError):
|
||||
"""
|
||||
Errors encountered while parsing message content.
|
||||
|
||||
Raised when raw provider payloads cannot be interpreted
|
||||
or normalized into internal domain models.
|
||||
Notes:
|
||||
**Lifecycle:**
|
||||
|
||||
- Raised when raw provider payloads cannot be interpreted or
|
||||
normalized into internal domain models.
|
||||
"""
|
||||
|
||||
4
mail_intake/exceptions.pyi
Normal file
4
mail_intake/exceptions.pyi
Normal file
@@ -0,0 +1,4 @@
|
||||
class MailIntakeError(Exception): ...
|
||||
class MailIntakeAuthError(MailIntakeError): ...
|
||||
class MailIntakeAdapterError(MailIntakeError): ...
|
||||
class MailIntakeParsingError(MailIntakeError): ...
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Mail ingestion orchestration for Mail Intake.
|
||||
|
||||
This package contains **high-level ingestion components** responsible for
|
||||
@@ -8,13 +10,22 @@ It represents the **top of the ingestion pipeline** and is intended to be the
|
||||
primary interaction surface for library consumers.
|
||||
|
||||
Components in this package:
|
||||
- Are provider-agnostic
|
||||
- Depend only on adapter and parser contracts
|
||||
- Contain no provider-specific API logic
|
||||
- Expose read-only ingestion workflows
|
||||
|
||||
- Are provider-agnostic.
|
||||
- Depend only on adapter and parser contracts.
|
||||
- Contain no provider-specific API logic.
|
||||
- Expose read-only ingestion workflows.
|
||||
|
||||
Consumers are expected to construct a mail adapter and pass it to the
|
||||
ingestion layer to begin processing messages and threads.
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
- `MailIntakeReader`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from .reader import MailIntakeReader
|
||||
|
||||
3
mail_intake/ingestion/__init__.pyi
Normal file
3
mail_intake/ingestion/__init__.pyi
Normal file
@@ -0,0 +1,3 @@
|
||||
from .reader import MailIntakeReader
|
||||
|
||||
__all__ = ["MailIntakeReader"]
|
||||
@@ -1,47 +1,53 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
High-level mail ingestion orchestration for Mail Intake.
|
||||
|
||||
This module provides the primary, provider-agnostic entry point for
|
||||
reading and processing mail data.
|
||||
|
||||
It coordinates:
|
||||
- Mail adapter access
|
||||
- Message and thread iteration
|
||||
- Header and body parsing
|
||||
- Normalization and model construction
|
||||
|
||||
- Mail adapter access.
|
||||
- Message and thread iteration.
|
||||
- Header and body parsing.
|
||||
- Normalization and model construction.
|
||||
|
||||
No provider-specific logic or API semantics are permitted in this layer.
|
||||
"""
|
||||
|
||||
from collections.abc import Iterator
|
||||
from datetime import datetime
|
||||
from typing import Iterator, Dict, Any
|
||||
from typing import Any
|
||||
|
||||
from mail_intake.adapters.base import MailIntakeAdapter
|
||||
from mail_intake.exceptions import MailIntakeParsingError
|
||||
from mail_intake.models.message import MailIntakeMessage
|
||||
from mail_intake.models.thread import MailIntakeThread
|
||||
from mail_intake.parsers.headers import parse_headers, extract_sender
|
||||
from mail_intake.parsers.body import extract_body
|
||||
from mail_intake.parsers.headers import extract_sender, parse_headers
|
||||
from mail_intake.parsers.subject import normalize_subject
|
||||
from mail_intake.exceptions import MailIntakeParsingError
|
||||
|
||||
|
||||
class MailIntakeReader:
|
||||
"""
|
||||
High-level read-only ingestion interface.
|
||||
|
||||
This class is the **primary entry point** for consumers of the Mail
|
||||
Intake library.
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
It orchestrates the full ingestion pipeline:
|
||||
- Querying the adapter for message references
|
||||
- Fetching raw provider messages
|
||||
- Parsing and normalizing message data
|
||||
- Constructing domain models
|
||||
- This class is the primary entry point for consumers of the
|
||||
Mail Intake library.
|
||||
- It orchestrates the full ingestion pipeline:
|
||||
- Querying the adapter for message references.
|
||||
- Fetching raw provider messages.
|
||||
- Parsing and normalizing message data.
|
||||
- Constructing domain models.
|
||||
|
||||
This class is intentionally:
|
||||
- Provider-agnostic
|
||||
- Stateless beyond iteration scope
|
||||
- Read-only
|
||||
**Constraints:**
|
||||
|
||||
- This class is intentionally: Provider-agnostic, stateless beyond
|
||||
iteration scope, read-only.
|
||||
"""
|
||||
|
||||
def __init__(self, adapter: MailIntakeAdapter):
|
||||
@@ -49,8 +55,8 @@ class MailIntakeReader:
|
||||
Initialize the mail reader.
|
||||
|
||||
Args:
|
||||
adapter: Mail adapter implementation used to retrieve raw
|
||||
messages and threads from a mail provider.
|
||||
adapter (MailIntakeAdapter):
|
||||
Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
|
||||
"""
|
||||
self._adapter = adapter
|
||||
|
||||
@@ -59,13 +65,16 @@ class MailIntakeReader:
|
||||
Iterate over parsed messages matching a provider query.
|
||||
|
||||
Args:
|
||||
query: Provider-specific query string used to filter messages.
|
||||
query (str):
|
||||
Provider-specific query string used to filter messages.
|
||||
|
||||
Yields:
|
||||
Fully parsed and normalized `MailIntakeMessage` instances.
|
||||
MailIntakeMessage:
|
||||
Fully parsed and normalized `MailIntakeMessage` instances.
|
||||
|
||||
Raises:
|
||||
MailIntakeParsingError: If a message cannot be parsed.
|
||||
MailIntakeParsingError:
|
||||
If a message cannot be parsed.
|
||||
"""
|
||||
for ref in self._adapter.iter_message_refs(query):
|
||||
raw = self._adapter.fetch_message(ref["message_id"])
|
||||
@@ -75,19 +84,25 @@ class MailIntakeReader:
|
||||
"""
|
||||
Iterate over threads constructed from messages matching a query.
|
||||
|
||||
Messages are grouped by `thread_id` and yielded as complete thread
|
||||
objects containing all associated messages.
|
||||
|
||||
Args:
|
||||
query: Provider-specific query string used to filter messages.
|
||||
query (str):
|
||||
Provider-specific query string used to filter messages.
|
||||
|
||||
Returns:
|
||||
An iterator of `MailIntakeThread` instances.
|
||||
Iterator[MailIntakeThread]:
|
||||
An iterator over `MailIntakeThread` instances.
|
||||
|
||||
Raises:
|
||||
MailIntakeParsingError: If a message cannot be parsed.
|
||||
`MailIntakeParsingError`:
|
||||
If a message cannot be parsed.
|
||||
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
- Messages are grouped by `thread_id` and yielded as complete
|
||||
thread objects containing all associated messages.
|
||||
"""
|
||||
threads: Dict[str, MailIntakeThread] = {}
|
||||
threads: dict[str, MailIntakeThread] = {}
|
||||
|
||||
for ref in self._adapter.iter_message_refs(query):
|
||||
raw = self._adapter.fetch_message(ref["message_id"])
|
||||
@@ -105,19 +120,21 @@ class MailIntakeReader:
|
||||
|
||||
return iter(threads.values())
|
||||
|
||||
def _parse_message(self, raw_message: Dict[str, Any]) -> MailIntakeMessage:
|
||||
def _parse_message(self, raw_message: dict[str, Any]) -> MailIntakeMessage:
|
||||
"""
|
||||
Parse a raw provider message into a `MailIntakeMessage`.
|
||||
|
||||
Args:
|
||||
raw_message: Provider-native message payload.
|
||||
raw_message (dict[str, Any]):
|
||||
Provider-native message payload.
|
||||
|
||||
Returns:
|
||||
A fully populated `MailIntakeMessage` instance.
|
||||
MailIntakeMessage:
|
||||
A fully populated `MailIntakeMessage` instance.
|
||||
|
||||
Raises:
|
||||
MailIntakeParsingError: If the message payload is missing required
|
||||
fields or cannot be parsed.
|
||||
MailIntakeParsingError:
|
||||
If the message payload is missing required fields or cannot be parsed.
|
||||
"""
|
||||
try:
|
||||
message_id = raw_message["id"]
|
||||
|
||||
12
mail_intake/ingestion/reader.pyi
Normal file
12
mail_intake/ingestion/reader.pyi
Normal file
@@ -0,0 +1,12 @@
|
||||
from collections.abc import Iterator
|
||||
from typing import Any
|
||||
|
||||
from mail_intake.adapters.base import MailIntakeAdapter
|
||||
from mail_intake.models.message import MailIntakeMessage
|
||||
from mail_intake.models.thread import MailIntakeThread
|
||||
|
||||
class MailIntakeReader:
|
||||
def __init__(self, adapter: MailIntakeAdapter) -> None: ...
|
||||
def iter_messages(self, query: str) -> Iterator[MailIntakeMessage]: ...
|
||||
def iter_threads(self, query: str) -> Iterator[MailIntakeThread]: ...
|
||||
def _parse_message(self, raw_message: dict[str, Any]) -> MailIntakeMessage: ...
|
||||
@@ -1,16 +1,28 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Domain models for Mail Intake.
|
||||
|
||||
This package defines the **canonical, provider-agnostic data models**
|
||||
used throughout the Mail Intake ingestion pipeline.
|
||||
|
||||
Models in this package:
|
||||
- Represent fully parsed and normalized mail data
|
||||
- Are safe to persist, serialize, and index
|
||||
- Contain no provider-specific payloads or API semantics
|
||||
- Serve as stable inputs for downstream processing and analysis
|
||||
|
||||
- Represent fully parsed and normalized mail data.
|
||||
- Are safe to persist, serialize, and index.
|
||||
- Contain no provider-specific payloads or API semantics.
|
||||
- Serve as stable inputs for downstream processing and analysis.
|
||||
|
||||
These models form the core internal data contract of the library.
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
- `MailIntakeMessage`
|
||||
- `MailIntakeThread`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from .message import MailIntakeMessage
|
||||
|
||||
4
mail_intake/models/__init__.pyi
Normal file
4
mail_intake/models/__init__.pyi
Normal file
@@ -0,0 +1,4 @@
|
||||
from .message import MailIntakeMessage
|
||||
from .thread import MailIntakeThread
|
||||
|
||||
__all__ = ["MailIntakeMessage", "MailIntakeThread"]
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Message domain models for Mail Intake.
|
||||
|
||||
This module defines the **canonical, provider-agnostic representation**
|
||||
@@ -11,7 +13,6 @@ provider-specific fields or semantics.
|
||||
|
||||
from dataclasses import dataclass
|
||||
from datetime import datetime
|
||||
from typing import Optional, Dict
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
@@ -19,37 +20,60 @@ 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."""
|
||||
from_name: str | None
|
||||
"""
|
||||
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)."""
|
||||
raw_headers: dict[str, str]
|
||||
"""
|
||||
Normalized mapping of message headers (header name → value).
|
||||
"""
|
||||
|
||||
24
mail_intake/models/message.pyi
Normal file
24
mail_intake/models/message.pyi
Normal file
@@ -0,0 +1,24 @@
|
||||
from datetime import datetime
|
||||
|
||||
class MailIntakeMessage:
|
||||
message_id: str
|
||||
thread_id: str
|
||||
timestamp: datetime
|
||||
from_email: str
|
||||
from_name: str | None
|
||||
subject: str
|
||||
body_text: str
|
||||
snippet: str
|
||||
raw_headers: dict[str, str]
|
||||
def __init__(
|
||||
self,
|
||||
message_id: str,
|
||||
thread_id: str,
|
||||
timestamp: datetime,
|
||||
from_email: str,
|
||||
from_name: str | None,
|
||||
subject: str,
|
||||
body_text: str,
|
||||
snippet: str,
|
||||
raw_headers: dict[str, str],
|
||||
) -> None: ...
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Thread domain models for Mail Intake.
|
||||
|
||||
This module defines the **canonical, provider-agnostic representation**
|
||||
@@ -10,7 +12,6 @@ for higher-level correspondence workflows.
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from datetime import datetime
|
||||
from typing import List, Set
|
||||
|
||||
from mail_intake.models.message import MailIntakeMessage
|
||||
|
||||
@@ -20,40 +21,55 @@ class MailIntakeThread:
|
||||
"""
|
||||
Canonical internal representation of an email thread.
|
||||
|
||||
A thread groups multiple related messages under a single subject
|
||||
and participant set. It is designed to support reasoning over
|
||||
conversational context such as job applications, interviews,
|
||||
follow-ups, and ongoing discussions.
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
This model is provider-agnostic and safe to persist.
|
||||
- A thread groups multiple related messages under a single subject
|
||||
and participant set.
|
||||
- It is designed to support reasoning over conversational context
|
||||
such as job applications, interviews, follow-ups, and ongoing discussions.
|
||||
- This model is provider-agnostic and safe to persist.
|
||||
"""
|
||||
|
||||
thread_id: str
|
||||
"""Provider-specific thread identifier."""
|
||||
"""
|
||||
Provider-specific thread identifier.
|
||||
"""
|
||||
|
||||
normalized_subject: str
|
||||
"""Normalized subject line used to group related messages."""
|
||||
"""
|
||||
Normalized subject line used to group related messages.
|
||||
"""
|
||||
|
||||
participants: Set[str] = field(default_factory=set)
|
||||
"""Set of unique participant email addresses observed in the thread."""
|
||||
participants: set[str] = field(default_factory=set)
|
||||
"""
|
||||
Set of unique participant email addresses observed in the thread.
|
||||
"""
|
||||
|
||||
messages: List[MailIntakeMessage] = field(default_factory=list)
|
||||
"""Ordered list of messages belonging to this thread."""
|
||||
messages: list[MailIntakeMessage] = field(default_factory=list)
|
||||
"""
|
||||
Ordered list of messages belonging to this thread.
|
||||
"""
|
||||
|
||||
last_activity_at: datetime | None = None
|
||||
"""Timestamp of the most recent message in the thread."""
|
||||
"""
|
||||
Timestamp of the most recent message in the thread.
|
||||
"""
|
||||
|
||||
def add_message(self, message: MailIntakeMessage) -> None:
|
||||
"""
|
||||
Add a message to the thread and update derived fields.
|
||||
|
||||
This method:
|
||||
- Appends the message to the thread
|
||||
- Tracks unique participants
|
||||
- Updates the last activity timestamp
|
||||
|
||||
Args:
|
||||
message: Parsed mail message to add to the thread.
|
||||
message (MailIntakeMessage):
|
||||
Parsed mail message to add to the thread.
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- Appends the message to the thread.
|
||||
- Tracks unique participants.
|
||||
- Updates the last activity timestamp.
|
||||
"""
|
||||
self.messages.append(message)
|
||||
|
||||
|
||||
19
mail_intake/models/thread.pyi
Normal file
19
mail_intake/models/thread.pyi
Normal file
@@ -0,0 +1,19 @@
|
||||
from datetime import datetime
|
||||
|
||||
from .message import MailIntakeMessage
|
||||
|
||||
class MailIntakeThread:
|
||||
thread_id: str
|
||||
normalized_subject: str
|
||||
participants: set[str]
|
||||
messages: list[MailIntakeMessage]
|
||||
last_activity_at: datetime | None
|
||||
def __init__(
|
||||
self,
|
||||
thread_id: str,
|
||||
normalized_subject: str,
|
||||
participants: set[str] = ...,
|
||||
messages: list[MailIntakeMessage] = ...,
|
||||
last_activity_at: datetime | None = ...,
|
||||
) -> None: ...
|
||||
def add_message(self, message: MailIntakeMessage) -> None: ...
|
||||
@@ -1,21 +1,36 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Message parsing utilities for Mail Intake.
|
||||
|
||||
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
|
||||
|
||||
- `extract_body`
|
||||
- `parse_headers`
|
||||
- `extract_sender`
|
||||
- `normalize_subject`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from .body import extract_body
|
||||
|
||||
5
mail_intake/parsers/__init__.pyi
Normal file
5
mail_intake/parsers/__init__.pyi
Normal file
@@ -0,0 +1,5 @@
|
||||
from .body import extract_body
|
||||
from .headers import extract_sender, parse_headers
|
||||
from .subject import normalize_subject
|
||||
|
||||
__all__ = ["extract_body", "parse_headers", "extract_sender", "normalize_subject"]
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Message body extraction utilities for Mail Intake.
|
||||
|
||||
This module contains helper functions for extracting a best-effort
|
||||
@@ -9,7 +11,7 @@ prefers human-readable text over fidelity to original formatting.
|
||||
"""
|
||||
|
||||
import base64
|
||||
from typing import Dict, Any, Optional
|
||||
from typing import Any
|
||||
|
||||
from bs4 import BeautifulSoup
|
||||
|
||||
@@ -24,13 +26,16 @@ def _decode_base64(data: str) -> str:
|
||||
omit padding and use non-standard characters.
|
||||
|
||||
Args:
|
||||
data: URL-safe base64-encoded string.
|
||||
data (str):
|
||||
URL-safe base64-encoded string.
|
||||
|
||||
Returns:
|
||||
Decoded UTF-8 text with replacement for invalid characters.
|
||||
str:
|
||||
Decoded UTF-8 text with replacement for invalid characters.
|
||||
|
||||
Raises:
|
||||
MailIntakeParsingError: If decoding fails.
|
||||
MailIntakeParsingError:
|
||||
If decoding fails.
|
||||
"""
|
||||
try:
|
||||
padded = data.replace("-", "+").replace("_", "/")
|
||||
@@ -40,19 +45,22 @@ def _decode_base64(data: str) -> str:
|
||||
raise MailIntakeParsingError("Failed to decode message body") from exc
|
||||
|
||||
|
||||
def _extract_from_part(part: Dict[str, Any]) -> Optional[str]:
|
||||
def _extract_from_part(part: dict[str, Any]) -> str | None:
|
||||
"""
|
||||
Extract text content from a single MIME part.
|
||||
|
||||
Supports:
|
||||
- text/plain
|
||||
- text/html (converted to plain text)
|
||||
|
||||
- `text/plain`
|
||||
- `text/html` (converted to plain text)
|
||||
|
||||
Args:
|
||||
part: MIME part dictionary from a provider payload.
|
||||
part (dict[str, Any]):
|
||||
MIME part dictionary from a provider payload.
|
||||
|
||||
Returns:
|
||||
Extracted plain-text content, or None if unsupported or empty.
|
||||
str | None:
|
||||
Extracted plain-text content, or `None` if unsupported or empty.
|
||||
"""
|
||||
mime_type = part.get("mimeType")
|
||||
body = part.get("body", {})
|
||||
@@ -74,21 +82,24 @@ def _extract_from_part(part: Dict[str, Any]) -> Optional[str]:
|
||||
return None
|
||||
|
||||
|
||||
def extract_body(payload: Dict[str, Any]) -> str:
|
||||
def extract_body(payload: dict[str, Any]) -> str:
|
||||
"""
|
||||
Extract the best-effort message body from a Gmail payload.
|
||||
|
||||
Priority:
|
||||
1. text/plain
|
||||
2. text/html (stripped to text)
|
||||
|
||||
1. `text/plain`
|
||||
2. `text/html` (stripped to text)
|
||||
3. Single-part body
|
||||
4. empty string (if nothing usable found)
|
||||
4. Empty string (if nothing usable found)
|
||||
|
||||
Args:
|
||||
payload: Provider-native message payload dictionary.
|
||||
payload (dict[str, Any]):
|
||||
Provider-native message payload dictionary.
|
||||
|
||||
Returns:
|
||||
Extracted plain-text message body.
|
||||
str:
|
||||
Extracted plain-text message body.
|
||||
"""
|
||||
if not payload:
|
||||
return ""
|
||||
|
||||
3
mail_intake/parsers/body.pyi
Normal file
3
mail_intake/parsers/body.pyi
Normal file
@@ -0,0 +1,3 @@
|
||||
from typing import Any
|
||||
|
||||
def extract_body(payload: dict[str, Any]) -> str: ...
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user