Initial commit: webmail client (M0/M1)
Three-pane webmail client. - Backend: FastAPI + async SQLAlchemy + arq worker (Postgres/Redis), IMAP/SMTP sync, threading, search, drafts/outbox with undo, attachments, 2FA. - Frontend: React 18 + Vite + TypeScript + TanStack Query + Tailwind; three-pane UI with rich-text composer, light/dark themes, resizable panels. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,111 @@
|
||||
# INTERFACE VERSION: 1
|
||||
"""MailProvider — the frozen provider contract (SPEC §5.1).
|
||||
|
||||
This signature is a frozen contract (SPEC instruction 5): implementations may
|
||||
evolve, signatures may not without bumping the version comment above.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import AsyncIterator
|
||||
from dataclasses import dataclass
|
||||
from datetime import datetime
|
||||
from typing import Protocol
|
||||
|
||||
|
||||
class ProviderError(Exception):
|
||||
"""Base class for provider errors; carries a human-readable ``.detail``."""
|
||||
|
||||
def __init__(self, detail: str) -> None:
|
||||
super().__init__(detail)
|
||||
self.detail = detail
|
||||
|
||||
|
||||
class ProviderAuthError(ProviderError):
|
||||
"""Authentication failed (bad credentials / token)."""
|
||||
|
||||
|
||||
class ProviderConnectError(ProviderError):
|
||||
"""Could not connect / TLS / greeting failure."""
|
||||
|
||||
|
||||
class ProviderNotSupported(ProviderError):
|
||||
"""A capability (e.g. IDLE) is not supported by the server."""
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class RemoteMailbox:
|
||||
path: str
|
||||
special_use: str | None # "inbox"|"sent"|"drafts"|"trash"|"junk"|"archive"|None
|
||||
uidvalidity: int
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class RemoteMessage:
|
||||
uid: int
|
||||
raw: bytes # full RFC822
|
||||
flags: frozenset[str]
|
||||
internal_date: datetime
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class FlagChange:
|
||||
uid: int
|
||||
flags: frozenset[str]
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class MailboxDelta:
|
||||
new: list[RemoteMessage]
|
||||
flag_changes: list[FlagChange]
|
||||
expunged_uids: list[int]
|
||||
new_uidvalidity: int | None # non-None => UIDVALIDITY changed, caller must full-resync
|
||||
new_highestmodseq: int | None
|
||||
|
||||
|
||||
class MailProvider(Protocol):
|
||||
async def verify(self) -> None:
|
||||
"""Raises ProviderAuthError / ProviderConnectError with a human-readable .detail."""
|
||||
...
|
||||
|
||||
async def list_mailboxes(self) -> list[RemoteMailbox]: ...
|
||||
|
||||
def backfill(
|
||||
self, mailbox: str, *, newest_first: bool = True, batch_size: int = 200
|
||||
) -> AsyncIterator[list[RemoteMessage]]:
|
||||
"""Yields batches until the mailbox is exhausted. Headers+body in one pass."""
|
||||
...
|
||||
|
||||
async def poll(
|
||||
self, mailbox: str, *, last_seen_uid: int, highestmodseq: int | None
|
||||
) -> MailboxDelta:
|
||||
"""One reconciliation pass. Uses QRESYNC/CONDSTORE when highestmodseq is not None,
|
||||
otherwise UID SEARCH + FETCH FLAGS diff."""
|
||||
...
|
||||
|
||||
async def idle(self, mailbox: str) -> None:
|
||||
"""Blocks until the server signals change or 25 min elapse (re-issue IDLE). May raise
|
||||
ProviderNotSupported => sync loop falls back to poll() every POLL_INTERVAL (default 120 s).
|
||||
"""
|
||||
...
|
||||
|
||||
async def push_flags(
|
||||
self, mailbox: str, uid: int, add: frozenset[str], remove: frozenset[str]
|
||||
) -> None: ...
|
||||
|
||||
async def move(self, uid: int, src: str, dst: str) -> int: # returns new UID
|
||||
...
|
||||
|
||||
async def delete_messages(self, mailbox: str, uids: list[int]) -> None:
|
||||
"""Permanently delete messages: set \\Deleted then EXPUNGE (SPEC §6.3)."""
|
||||
...
|
||||
|
||||
async def append(
|
||||
self, mailbox: str, raw: bytes, flags: frozenset[str]
|
||||
) -> int: # Sent/Drafts upload
|
||||
...
|
||||
|
||||
async def send(
|
||||
self, raw: bytes, envelope_from: str, envelope_to: list[str]
|
||||
) -> None: # SMTP submission
|
||||
...
|
||||
Reference in New Issue
Block a user