diff --git a/mail-intake/lib/mail_intake/adapters/base/index.html b/mail-intake/lib/mail_intake/adapters/base/index.html
deleted file mode 100644
index 16f663c..0000000
--- a/mail-intake/lib/mail_intake/adapters/base/index.html
+++ /dev/null
@@ -1,1600 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Base - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Base
-
-
-
-
-
-
-
-mail_intake.adapters.base
-
-
-
-
-
-
-
Summary
-
Mail provider adapter contracts for Mail Intake.
-
This module defines the provider-agnostic adapter interface used for
-read-only mail ingestion.
-
Adapters encapsulate all provider-specific access logic and expose a
-minimal, normalized contract to the rest of the system. No provider-specific
-types or semantics should leak beyond implementations of this interface.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeAdapter
-
-
-
-
-
-
-
- Bases: ABC
-
-
-
Base adapter interface for mail providers.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-fetch_message
-
-
-
- abstractmethod
-
-
-
fetch_message ( message_id : str ) -> dict [ str , Any ]
-
-
-
-
-
Fetch a full raw message by message identifier.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- message_id
- str
-
-
-
-
Provider-specific message identifier.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, Any ]
-
-
-
-
dict[str, Any]:
-Provider-native message payload (e.g., Gmail message JSON structure).
-
-
-
-
-
-
-
-
-
-
-
-
-
-fetch_thread
-
-
-
- abstractmethod
-
-
-
fetch_thread ( thread_id : str ) -> dict [ str , Any ]
-
-
-
-
-
Fetch a full raw thread by thread identifier.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- thread_id
- str
-
-
-
-
Provider-specific thread identifier.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, Any ]
-
-
-
-
dict[str, Any]:
-Provider-native thread payload.
-
-
-
-
-
-
-
-
-
-
-
-
-
-iter_message_refs
-
-
-
- abstractmethod
-
-
-
iter_message_refs ( query : str ) -> Iterator [ dict [ str , str ]]
-
-
-
-
-
Iterate over lightweight message references matching a query.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- query
- str
-
-
-
-
Provider-specific query string used to filter messages.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterator [dict[str, str]]
-
-
-
Iterator[dict[str, str]]:
-An iterator over lightweight message reference dictionaries.
-
-
-
-
-
-
-
Yields:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, str]
-
-
-
-
dict[str, str]:
-Dictionaries containing message and thread identifiers.
-
-
-
-
-
-
-
- Notes
- Guarantees:
-- Implementations must yield dictionaries containing at least
- `message_id` and `thread_id`.
-
-
-
- Example
- Typical yield:
-{
-"message_id" : "..." ,
-"thread_id" : "..."
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/adapters/gmail/index.html b/mail-intake/lib/mail_intake/adapters/gmail/index.html
deleted file mode 100644
index 83457fd..0000000
--- a/mail-intake/lib/mail_intake/adapters/gmail/index.html
+++ /dev/null
@@ -1,1744 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Gmail - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Gmail
-
-
-
-
-
-
-
-mail_intake.adapters.gmail
-
-
-
-
-
-
-
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.
-
-
All Gmail-specific behavior must be strictly contained within this module.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeGmailAdapter
-
-
-
-
MailIntakeGmailAdapter (
-auth_provider : MailIntakeAuthProvider [ Any ],
-user_id : str = "me" ,
-)
-
-
-
-
- Bases: MailIntakeAdapter
-
-
-
Gmail read-only adapter.
-
This adapter implements the MailIntakeAdapter interface using the
-Gmail REST API. It translates the generic mail intake contract into
-Gmail-specific API calls.
-
-
-
- Notes
- Responsibilities:
-- 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.
-
-
Initialize the Gmail adapter.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- auth_provider
- MailIntakeAuthProvider
-
-
-
Authentication provider capable of supplying valid Gmail API credentials.
-
-
- required
-
-
-
- user_id
- str
-
-
-
-
Gmail user identifier. Defaults to "me".
-
-
- 'me'
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Attributes
-
-
-
-
-
-
-service
-
-
-
- property
-
-
-
-
-
-
-
Lazily initialize and return the Gmail API service client.
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- MailIntakeAdapterError
-
-
-
If the Gmail service cannot be initialized.
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-fetch_message
-
-
-
-
fetch_message ( message_id : str ) -> dict [ str , Any ]
-
-
-
-
-
Fetch a full Gmail message by message ID.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- message_id
- str
-
-
-
-
Gmail message identifier.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, Any ]
-
-
-
-
dict[str, Any]:
-Provider-native Gmail message payload.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- MailIntakeAdapterError
-
-
-
If the Gmail API returns an error.
-
-
-
-
-
-
-
-
-
-
-
-
-
-fetch_thread
-
-
-
-
fetch_thread ( thread_id : str ) -> dict [ str , Any ]
-
-
-
-
-
Fetch a full Gmail thread by thread ID.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- thread_id
- str
-
-
-
-
Gmail thread identifier.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, Any ]
-
-
-
-
dict[str, Any]:
-Provider-native Gmail thread payload.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- MailIntakeAdapterError
-
-
-
If the Gmail API returns an error.
-
-
-
-
-
-
-
-
-
-
-
-
-
-iter_message_refs
-
-
-
-
iter_message_refs ( query : str ) -> Iterator [ dict [ str , str ]]
-
-
-
-
-
Iterate over message references matching the query.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- query
- str
-
-
-
-
Gmail search query string.
-
-
- required
-
-
-
-
-
-
-
Yields:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, str]
-
-
-
-
dict[str, str]:
-Dictionaries containing message_id and thread_id.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- MailIntakeAdapterError
-
-
-
If the Gmail API returns an error.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/adapters/index.html b/mail-intake/lib/mail_intake/adapters/index.html
deleted file mode 100644
index ab6a5ca..0000000
--- a/mail-intake/lib/mail_intake/adapters/index.html
+++ /dev/null
@@ -1,2151 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Adapters - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Adapters
-
-
-
-
-
-
-
-mail_intake.adapters
-
-
-
-
-
-
-
Summary
-
Mail provider adapter implementations for Mail Intake.
-
This package contains adapter-layer implementations responsible for
-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.
-
-
Provider-specific logic must not leak outside of adapter implementations.
-All parsings, normalizations, and transformations must be handled by downstream
-components.
-
-
Public API
-
-MailIntakeAdapterMailIntakeGmailAdapter
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeAdapter
-
-
-
-
-
-
-
- Bases: ABC
-
-
-
Base adapter interface for mail providers.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-fetch_message
-
-
-
- abstractmethod
-
-
-
fetch_message ( message_id : str ) -> dict [ str , Any ]
-
-
-
-
-
Fetch a full raw message by message identifier.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- message_id
- str
-
-
-
-
Provider-specific message identifier.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, Any ]
-
-
-
-
dict[str, Any]:
-Provider-native message payload (e.g., Gmail message JSON structure).
-
-
-
-
-
-
-
-
-
-
-
-
-
-fetch_thread
-
-
-
- abstractmethod
-
-
-
fetch_thread ( thread_id : str ) -> dict [ str , Any ]
-
-
-
-
-
Fetch a full raw thread by thread identifier.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- thread_id
- str
-
-
-
-
Provider-specific thread identifier.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, Any ]
-
-
-
-
dict[str, Any]:
-Provider-native thread payload.
-
-
-
-
-
-
-
-
-
-
-
-
-
-iter_message_refs
-
-
-
- abstractmethod
-
-
-
iter_message_refs ( query : str ) -> Iterator [ dict [ str , str ]]
-
-
-
-
-
Iterate over lightweight message references matching a query.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- query
- str
-
-
-
-
Provider-specific query string used to filter messages.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterator [dict[str, str]]
-
-
-
Iterator[dict[str, str]]:
-An iterator over lightweight message reference dictionaries.
-
-
-
-
-
-
-
Yields:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, str]
-
-
-
-
dict[str, str]:
-Dictionaries containing message and thread identifiers.
-
-
-
-
-
-
-
- Notes
- Guarantees:
-- Implementations must yield dictionaries containing at least
- `message_id` and `thread_id`.
-
-
-
- Example
- Typical yield:
-{
-"message_id" : "..." ,
-"thread_id" : "..."
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-MailIntakeGmailAdapter
-
-
-
-
MailIntakeGmailAdapter (
-auth_provider : MailIntakeAuthProvider [ Any ],
-user_id : str = "me" ,
-)
-
-
-
-
- Bases: MailIntakeAdapter
-
-
-
Gmail read-only adapter.
-
This adapter implements the MailIntakeAdapter interface using the
-Gmail REST API. It translates the generic mail intake contract into
-Gmail-specific API calls.
-
-
-
- Notes
- Responsibilities:
-- 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.
-
-
Initialize the Gmail adapter.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- auth_provider
- MailIntakeAuthProvider
-
-
-
Authentication provider capable of supplying valid Gmail API credentials.
-
-
- required
-
-
-
- user_id
- str
-
-
-
-
Gmail user identifier. Defaults to "me".
-
-
- 'me'
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Attributes
-
-
-
-
-
-
-service
-
-
-
- property
-
-
-
-
-
-
-
Lazily initialize and return the Gmail API service client.
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- MailIntakeAdapterError
-
-
-
If the Gmail service cannot be initialized.
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-fetch_message
-
-
-
-
fetch_message ( message_id : str ) -> dict [ str , Any ]
-
-
-
-
-
Fetch a full Gmail message by message ID.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- message_id
- str
-
-
-
-
Gmail message identifier.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, Any ]
-
-
-
-
dict[str, Any]:
-Provider-native Gmail message payload.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- MailIntakeAdapterError
-
-
-
If the Gmail API returns an error.
-
-
-
-
-
-
-
-
-
-
-
-
-
-fetch_thread
-
-
-
-
fetch_thread ( thread_id : str ) -> dict [ str , Any ]
-
-
-
-
-
Fetch a full Gmail thread by thread ID.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- thread_id
- str
-
-
-
-
Gmail thread identifier.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, Any ]
-
-
-
-
dict[str, Any]:
-Provider-native Gmail thread payload.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- MailIntakeAdapterError
-
-
-
If the Gmail API returns an error.
-
-
-
-
-
-
-
-
-
-
-
-
-
-iter_message_refs
-
-
-
-
iter_message_refs ( query : str ) -> Iterator [ dict [ str , str ]]
-
-
-
-
-
Iterate over message references matching the query.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- query
- str
-
-
-
-
Gmail search query string.
-
-
- required
-
-
-
-
-
-
-
Yields:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, str]
-
-
-
-
dict[str, str]:
-Dictionaries containing message_id and thread_id.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- MailIntakeAdapterError
-
-
-
If the Gmail API returns an error.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/auth/base/index.html b/mail-intake/lib/mail_intake/auth/base/index.html
deleted file mode 100644
index 3cabcc5..0000000
--- a/mail-intake/lib/mail_intake/auth/base/index.html
+++ /dev/null
@@ -1,1405 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Base - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Base
-
-
-
-
-
-
-
-mail_intake.auth.base
-
-
-
-
-
-
-
Summary
-
Authentication provider contracts for Mail Intake.
-
This module defines the authentication abstraction layer used by mail
-adapters to obtain provider-specific credentials.
-
Authentication concerns are intentionally decoupled from adapter logic.
-Adapters depend only on this interface and must not be aware of how
-credentials are acquired, refreshed, or persisted.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeAuthProvider
-
-
-
-
-
-
-
- Bases: ABC Generic [T ]
-
-
-
Abstract base class for authentication providers.
-
This interface enforces a strict contract between authentication
-providers and mail adapters by requiring providers to explicitly
-declare the type of credentials they return.
-
-
-
- Notes
- Responsibilities:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-get_credentials
-
-
-
- abstractmethod
-
-
-
-
-
-
-
Retrieve valid, provider-specific credentials.
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-T
- T
-
-
-
Credentials of type T suitable for immediate use by the
-corresponding mail adapter.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/auth/google/index.html b/mail-intake/lib/mail_intake/auth/google/index.html
deleted file mode 100644
index 47debc2..0000000
--- a/mail-intake/lib/mail_intake/auth/google/index.html
+++ /dev/null
@@ -1,1467 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Google - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Google
-
-
-
-
-
-
-
-mail_intake.auth.google
-
-
-
-
-
-
-
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.
-
-
No Google authentication details should leak outside this module.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeGoogleAuth
-
-
-
-
MailIntakeGoogleAuth (
-credentials_path : str ,
-store : CredentialStore [ Any ],
-scopes : Sequence [ str ],
-)
-
-
-
-
- Bases: MailIntakeAuthProvider
-
-
-
Google OAuth provider for Gmail access.
-
This provider implements the MailIntakeAuthProvider interface using
-Google's OAuth 2.0 flow and credential management libraries.
-
-
-
- Notes
- 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.
-
Guarantees:
-- This class is synchronous by design and maintains a minimal
- internal state.
-
-
Initialize the Google authentication provider.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- credentials_path
- str
-
-
-
-
Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
-
-
- required
-
-
-
- store
- CredentialStore [Credentials ]
-
-
-
Credential store responsible for persisting and retrieving Google OAuth credentials.
-
-
- required
-
-
-
- scopes
- Sequence [str]
-
-
-
OAuth scopes required for Gmail access.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-get_credentials
-
-
-
-
get_credentials () -> Any
-
-
-
-
-
Retrieve valid Google OAuth credentials.
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Credentials
- Any
-
-
-
A google.oauth2.credentials.Credentials instance suitable
-for use with Google API clients.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/auth/index.html b/mail-intake/lib/mail_intake/auth/index.html
deleted file mode 100644
index a0b2d9c..0000000
--- a/mail-intake/lib/mail_intake/auth/index.html
+++ /dev/null
@@ -1,1680 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Auth - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Auth
-
-
-
-
-
-
-
-mail_intake.auth
-
-
-
-
-
-
-
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.
-
-
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.
-
-
Consumers should depend on the abstract interface and use concrete
-implementations only where explicitly required.
-
-
Public API
-
-MailIntakeAuthProviderMailIntakeGoogleAuth
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeAuthProvider
-
-
-
-
-
-
-
- Bases: ABC Generic [T ]
-
-
-
Abstract base class for authentication providers.
-
This interface enforces a strict contract between authentication
-providers and mail adapters by requiring providers to explicitly
-declare the type of credentials they return.
-
-
-
- Notes
- Responsibilities:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-get_credentials
-
-
-
- abstractmethod
-
-
-
-
-
-
-
Retrieve valid, provider-specific credentials.
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-T
- T
-
-
-
Credentials of type T suitable for immediate use by the
-corresponding mail adapter.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-MailIntakeGoogleAuth
-
-
-
-
MailIntakeGoogleAuth (
-credentials_path : str ,
-store : CredentialStore [ Any ],
-scopes : Sequence [ str ],
-)
-
-
-
-
- Bases: MailIntakeAuthProvider
-
-
-
Google OAuth provider for Gmail access.
-
This provider implements the MailIntakeAuthProvider interface using
-Google's OAuth 2.0 flow and credential management libraries.
-
-
-
- Notes
- 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.
-
Guarantees:
-- This class is synchronous by design and maintains a minimal
- internal state.
-
-
Initialize the Google authentication provider.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- credentials_path
- str
-
-
-
-
Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
-
-
- required
-
-
-
- store
- CredentialStore [Credentials ]
-
-
-
Credential store responsible for persisting and retrieving Google OAuth credentials.
-
-
- required
-
-
-
- scopes
- Sequence [str]
-
-
-
OAuth scopes required for Gmail access.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-get_credentials
-
-
-
-
get_credentials () -> Any
-
-
-
-
-
Retrieve valid Google OAuth credentials.
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-Credentials
- Any
-
-
-
A google.oauth2.credentials.Credentials instance suitable
-for use with Google API clients.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/config/index.html b/mail-intake/lib/mail_intake/config/index.html
deleted file mode 100644
index 3046fc5..0000000
--- a/mail-intake/lib/mail_intake/config/index.html
+++ /dev/null
@@ -1,1482 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Config - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Config
-
-
-
-
-
-
-
-mail_intake.config
-
-
-
-
-
-
-
Summary
-
Global configuration models for Mail Intake.
-
This module defines the top-level configuration object used to control
-mail ingestion behavior across adapters, authentication providers, and
-ingestion workflows.
-
Configuration is intentionally explicit, immutable, and free of implicit
-environment reads to ensure predictability and testability.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeConfig
-
-
-
- dataclass
-
-
-
MailIntakeConfig (
-provider : str = ... ,
-user_id : str = ... ,
-readonly : bool = ... ,
-credentials_path : str | None = ... ,
-token_path : str | None = ... ,
-)
-
-
-
-
-
-
Global configuration for mail-intake.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
Attributes
-
-
-
-
-
-
-credentials_path
-
-
-
- class-attributeinstance-attribute
-
-
-
credentials_path : str | None = None
-
-
-
-
-
Optional path to provider credentials configuration.
-
-
-
-
-
-
-
-
-
-provider
-
-
-
- class-attributeinstance-attribute
-
-
-
provider : str = 'gmail'
-
-
-
-
-
Identifier of the mail provider to use (e.g., "gmail").
-
-
-
-
-
-
-
-
-
-readonly
-
-
-
- class-attributeinstance-attribute
-
-
-
-
-
-
-
Whether ingestion should operate in read-only mode.
-
-
-
-
-
-
-
-
-
-token_path
-
-
-
- class-attributeinstance-attribute
-
-
-
token_path : str | None = None
-
-
-
-
-
Optional path to persisted authentication tokens.
-
-
-
-
-
-
-
-
-
-user_id
-
-
-
- class-attributeinstance-attribute
-
-
-
-
-
-
-
Provider-specific user identifier. Defaults to the authenticated user.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/credentials/index.html b/mail-intake/lib/mail_intake/credentials/index.html
deleted file mode 100644
index 8dfb105..0000000
--- a/mail-intake/lib/mail_intake/credentials/index.html
+++ /dev/null
@@ -1,2179 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Credentials - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Credentials
-
-
-
-
-
-
-
-mail_intake.credentials
-
-
-
-
-
-
-
Summary
-
Credential persistence interfaces and implementations for Mail Intake.
-
This package defines the abstractions and concrete implementations used
-to persist authentication credentials across Mail Intake components.
-
The credential persistence layer is intentionally decoupled from
-authentication logic. Authentication providers are responsible for
-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.
-
-
Credential lifecycle management, interpretation, and security policy
-decisions remain the responsibility of authentication providers.
-
-
Public API
-
-CredentialStorePickleCredentialStoreRedisCredentialStore
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-CredentialStore
-
-
-
-
-
-
-
- Bases: ABC Generic [T ]
-
-
-
Abstract base class defining a generic persistence interface.
-
Used for authentication credentials across different backends.
-
-
-
- Notes
- Responsibilities:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-clear
-
-
-
- abstractmethod
-
-
-
-
-
-
-
Remove any persisted credentials from the store.
-
-
-
- Notes
- Lifecycle:
-- 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
-
-
-
-
-
-
-
-
-
-load
-
-
-
- abstractmethod
-
-
-
-
-
-
-
Load previously persisted credentials.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- T | 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.
-
-
-
-
-
-
-
-
-
-save
-
-
-
- abstractmethod
-
-
-
save ( credentials : T ) -> None
-
-
-
-
-
Persist credentials to the underlying storage backend.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- credentials
- T
-
-
-
The credential object to persist.
-
-
- required
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-PickleCredentialStore
-
-
-
-
PickleCredentialStore ( path : str )
-
-
-
-
- Bases: CredentialStore [T ]
-
-
-
Filesystem-backed credential store using pickle serialization.
-
This store persists credentials as a pickled object on the local
-filesystem. It is a simple implementation intended primarily for
-development, testing, and single-process execution contexts.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
Initialize a pickle-backed credential store.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Filesystem path where credentials will be stored.
-The file will be created or overwritten as needed.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-clear
-
-
-
-
-
-
-
-
Remove persisted credentials from the local filesystem.
-
-
-
- Notes
- Lifecycle:
-- This method deletes the credential file if it exists and should be treated as an idempotent operation
-
-
-
-
-
-
-
-
-
-load
-
-
-
-
-
-
-
-
Load credentials from the local filesystem.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- T | 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.
-
-
-
-
-
-
-
-
-
-save
-
-
-
-
save ( credentials : T ) -> None
-
-
-
-
-
Persist credentials to the local filesystem.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- credentials
- T
-
-
-
The credential object to persist.
-
-
- required
-
-
-
-
-
-
-
- Notes
- Responsibilities:
-- Any previously stored credentials at the configured path are overwritten
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-RedisCredentialStore
-
-
-
-
RedisCredentialStore (
-redis_client : Any ,
-key : str ,
-serialize : Callable [[ T ], bytes ],
-deserialize : Callable [[ bytes ], T ],
-ttl_seconds : int | None = None ,
-)
-
-
-
-
- Bases: CredentialStore [T ]
-
-
-
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.
-
-
-
- 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.
-
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.
-
-
Initialize a Redis-backed credential store.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- redis_client
- Any
-
-
-
Initialized Redis client instance used for persistence.
-
-
- required
-
-
-
- key
- str
-
-
-
-
Storage key under which credentials are persisted.
-
-
- required
-
-
-
- serialize
- Callable [[T ], bytes]
-
-
-
Callable that encodes credentials to bytes for storage.
-
-
- required
-
-
-
- deserialize
- Callable [[bytes], T ]
-
-
-
Callable that decodes stored bytes back into credentials.
-
-
- required
-
-
-
- ttl_seconds
- int | None
-
-
-
-
Optional time-to-live in seconds after which stored
-credentials expire automatically. None disables expiry.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-clear
-
-
-
-
-
-
-
-
Remove stored credentials from Redis.
-
-
-
- Notes
- Lifecycle:
-- This operation deletes the configured Redis key if it exists
-- Implementations should treat this method as idempotent
-
-
-
-
-
-
-
-
-
-load
-
-
-
-
-
-
-
-
Load credentials from Redis.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- T | 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.
-
-
-
-
-
-
-
-
-
-save
-
-
-
-
save ( credentials : T ) -> None
-
-
-
-
-
Persist credentials to Redis.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- credentials
- T
-
-
-
The credential object to persist.
-
-
- required
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/credentials/pickle/index.html b/mail-intake/lib/mail_intake/credentials/pickle/index.html
deleted file mode 100644
index 06eb905..0000000
--- a/mail-intake/lib/mail_intake/credentials/pickle/index.html
+++ /dev/null
@@ -1,1505 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Pickle - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Pickle
-
-
-
-
-
-
-
-mail_intake.credentials.pickle
-
-
-
-
-
-
-
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.
-
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
-serialization, this implementation is not suitable for distributed or
-untrusted environments.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-PickleCredentialStore
-
-
-
-
PickleCredentialStore ( path : str )
-
-
-
-
- Bases: CredentialStore [T ]
-
-
-
Filesystem-backed credential store using pickle serialization.
-
This store persists credentials as a pickled object on the local
-filesystem. It is a simple implementation intended primarily for
-development, testing, and single-process execution contexts.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
Initialize a pickle-backed credential store.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- path
- str
-
-
-
-
Filesystem path where credentials will be stored.
-The file will be created or overwritten as needed.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-clear
-
-
-
-
-
-
-
-
Remove persisted credentials from the local filesystem.
-
-
-
- Notes
- Lifecycle:
-- This method deletes the credential file if it exists and should be treated as an idempotent operation
-
-
-
-
-
-
-
-
-
-load
-
-
-
-
-
-
-
-
Load credentials from the local filesystem.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- T | 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.
-
-
-
-
-
-
-
-
-
-save
-
-
-
-
save ( credentials : T ) -> None
-
-
-
-
-
Persist credentials to the local filesystem.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- credentials
- T
-
-
-
The credential object to persist.
-
-
- required
-
-
-
-
-
-
-
- Notes
- Responsibilities:
-- Any previously stored credentials at the configured path are overwritten
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/credentials/redis/index.html b/mail-intake/lib/mail_intake/credentials/redis/index.html
deleted file mode 100644
index b3c2beb..0000000
--- a/mail-intake/lib/mail_intake/credentials/redis/index.html
+++ /dev/null
@@ -1,1594 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Redis - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Redis
-
-
-
-
-
-
-
-mail_intake.credentials.redis
-
-
-
-
-
-
-
Summary
-
Redis-backed credential persistence for Mail Intake.
-
This module provides a Redis-based implementation of the
-CredentialStore abstraction, enabling credential persistence
-across distributed and horizontally scaled deployments.
-
The Redis credential store is designed for environments where
-authentication credentials must be shared safely across multiple
-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.
-
-
This module is responsible solely for persistence concerns.
-Credential validation, refresh, rotation, and acquisition remain the
-responsibility of authentication provider implementations.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-RedisCredentialStore
-
-
-
-
RedisCredentialStore (
-redis_client : Any ,
-key : str ,
-serialize : Callable [[ T ], bytes ],
-deserialize : Callable [[ bytes ], T ],
-ttl_seconds : int | None = None ,
-)
-
-
-
-
- Bases: CredentialStore [T ]
-
-
-
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.
-
-
-
- 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.
-
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.
-
-
Initialize a Redis-backed credential store.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- redis_client
- Any
-
-
-
Initialized Redis client instance used for persistence.
-
-
- required
-
-
-
- key
- str
-
-
-
-
Storage key under which credentials are persisted.
-
-
- required
-
-
-
- serialize
- Callable [[T ], bytes]
-
-
-
Callable that encodes credentials to bytes for storage.
-
-
- required
-
-
-
- deserialize
- Callable [[bytes], T ]
-
-
-
Callable that decodes stored bytes back into credentials.
-
-
- required
-
-
-
- ttl_seconds
- int | None
-
-
-
-
Optional time-to-live in seconds after which stored
-credentials expire automatically. None disables expiry.
-
-
- None
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-clear
-
-
-
-
-
-
-
-
Remove stored credentials from Redis.
-
-
-
- Notes
- Lifecycle:
-- This operation deletes the configured Redis key if it exists
-- Implementations should treat this method as idempotent
-
-
-
-
-
-
-
-
-
-load
-
-
-
-
-
-
-
-
Load credentials from Redis.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- T | 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.
-
-
-
-
-
-
-
-
-
-save
-
-
-
-
save ( credentials : T ) -> None
-
-
-
-
-
Persist credentials to Redis.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- credentials
- T
-
-
-
The credential object to persist.
-
-
- required
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/credentials/store/index.html b/mail-intake/lib/mail_intake/credentials/store/index.html
deleted file mode 100644
index c4c8b34..0000000
--- a/mail-intake/lib/mail_intake/credentials/store/index.html
+++ /dev/null
@@ -1,1504 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Store - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Store
-
-
-
-
-
-
-
-mail_intake.credentials.store
-
-
-
-
-
-
-
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
-between credential lifecycle management and credential storage .
-Authentication providers are responsible for acquiring, validating,
-refreshing, and revoking credentials, while concrete store
-implementations are responsible solely for persistence concerns.
-
By remaining agnostic to credential structure, serialization format,
-and storage backend, this module enables multiple persistence
-strategies—such as local files, in-memory caches, distributed stores,
-or secrets managers—without coupling authentication logic to any
-specific storage mechanism.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-CredentialStore
-
-
-
-
-
-
-
- Bases: ABC Generic [T ]
-
-
-
Abstract base class defining a generic persistence interface.
-
Used for authentication credentials across different backends.
-
-
-
- Notes
- Responsibilities:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-clear
-
-
-
- abstractmethod
-
-
-
-
-
-
-
Remove any persisted credentials from the store.
-
-
-
- Notes
- Lifecycle:
-- 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
-
-
-
-
-
-
-
-
-
-load
-
-
-
- abstractmethod
-
-
-
-
-
-
-
Load previously persisted credentials.
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- T | 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.
-
-
-
-
-
-
-
-
-
-save
-
-
-
- abstractmethod
-
-
-
save ( credentials : T ) -> None
-
-
-
-
-
Persist credentials to the underlying storage backend.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- credentials
- T
-
-
-
The credential object to persist.
-
-
- required
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/exceptions/index.html b/mail-intake/lib/mail_intake/exceptions/index.html
deleted file mode 100644
index 48aad3f..0000000
--- a/mail-intake/lib/mail_intake/exceptions/index.html
+++ /dev/null
@@ -1,1382 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Exceptions - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Exceptions
-
-
-
-
-
-
-
-mail_intake.exceptions
-
-
-
-
-
-
-
Summary
-
Exception hierarchy for Mail Intake.
-
This module defines the canonical exception types used throughout the
-Mail Intake library.
-
All library-raised errors derive from MailIntakeError. Consumers are
-encouraged to catch this base type (or specific subclasses) rather than
-provider-specific or third-party exceptions.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeAdapterError
-
-
-
-
-
-
-
- Bases: MailIntakeError
-
-
-
Errors raised by mail provider adapters.
-
-
-
- Notes
- Lifecycle:
-- Raised when a provider adapter encounters API errors, transport
- failures, or invalid provider responses.
-
-
-
-
-
-
-
-
-
-
-
-MailIntakeAuthError
-
-
-
-
-
-
-
- Bases: MailIntakeError
-
-
-
Authentication and credential-related failures.
-
-
-
- Notes
- Lifecycle:
-- Raised when authentication providers are unable to acquire,
- refresh, or persist valid credentials.
-
-
-
-
-
-
-
-
-
-
-
-MailIntakeError
-
-
-
-
-
-
-
- Bases: Exception
-
-
-
Base exception for all Mail Intake errors.
-
-
-
- Notes
- Guarantees:
-- 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
-
-
-
-
-
-
-
-
-
-
-
-MailIntakeParsingError
-
-
-
-
-
-
-
- Bases: MailIntakeError
-
-
-
Errors encountered while parsing message content.
-
-
-
- Notes
- Lifecycle:
-- Raised when raw provider payloads cannot be interpreted or
- normalized into internal domain models.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/index.html b/mail-intake/lib/mail_intake/index.html
deleted file mode 100644
index 7e6db92..0000000
--- a/mail-intake/lib/mail_intake/index.html
+++ /dev/null
@@ -1,1364 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Mail Intake - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Mail Intake
-
-
-
-
-
-
-
-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:
-
install mail-intake
-
-
Or with Poetry:
-
-
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):
-
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:
-
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 :
-
-Layered Decoupling : Adapters handle transport, Parsers handle format
- normalization, and Ingestion orchestrates.Provider Agnosticism : Domain models and core logic never depend on
- provider-specific (e.g., Gmail) API internals.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.ingestionmail_intake.adaptersmail_intake.authmail_intake.credentialsmail_intake.parsersmail_intake.modelsmail_intake.configmail_intake.exceptions
-
Classes and functions should be imported explicitly from these modules.
-No individual symbols are re-exported at the package root.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/ingestion/index.html b/mail-intake/lib/mail_intake/ingestion/index.html
deleted file mode 100644
index f968b4e..0000000
--- a/mail-intake/lib/mail_intake/ingestion/index.html
+++ /dev/null
@@ -1,1580 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Ingestion - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Ingestion
-
-
-
-
-
-
-
-mail_intake.ingestion
-
-
-
-
-
-
-
Summary
-
Mail ingestion orchestration for Mail Intake.
-
This package contains high-level ingestion components responsible for
-coordinating mail retrieval, parsing, normalization, and model construction.
-
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.
-
-
Consumers are expected to construct a mail adapter and pass it to the
-ingestion layer to begin processing messages and threads.
-
-
Public API
-
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeReader
-
-
-
-
MailIntakeReader ( adapter : MailIntakeAdapter )
-
-
-
-
-
-
High-level read-only ingestion interface.
-
-
-
- Notes
- Responsibilities:
-- 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.
-
Constraints:
-- This class is intentionally: Provider-agnostic, stateless beyond
- iteration scope, read-only.
-
-
Initialize the mail reader.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- adapter
- MailIntakeAdapter
-
-
-
Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-iter_messages
-
-
-
-
iter_messages ( query : str ) -> Iterator [ MailIntakeMessage ]
-
-
-
-
-
Iterate over parsed messages matching a provider query.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- query
- str
-
-
-
-
Provider-specific query string used to filter messages.
-
-
- required
-
-
-
-
-
-
-
Yields:
-
-
-
-Name Type
- Description
-
-
-
-
-MailIntakeMessage
- MailIntakeMessage
-
-
-
Fully parsed and normalized MailIntakeMessage instances.
-
-
-
-
-
-
-
Raises:
-
-
-
-
-
-
-
-
-
-
-iter_threads
-
-
-
-
iter_threads ( query : str ) -> Iterator [ MailIntakeThread ]
-
-
-
-
-
Iterate over threads constructed from messages matching a query.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- query
- str
-
-
-
-
Provider-specific query string used to filter messages.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterator [MailIntakeThread ]
-
-
-
Iterator[MailIntakeThread]:
-An iterator over MailIntakeThread instances.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- `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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/ingestion/reader/index.html b/mail-intake/lib/mail_intake/ingestion/reader/index.html
deleted file mode 100644
index 4066da8..0000000
--- a/mail-intake/lib/mail_intake/ingestion/reader/index.html
+++ /dev/null
@@ -1,1569 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Reader - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Reader
-
-
-
-
-
-
-
-mail_intake.ingestion.reader
-
-
-
-
-
-
-
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.
-
-
No provider-specific logic or API semantics are permitted in this layer.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeReader
-
-
-
-
MailIntakeReader ( adapter : MailIntakeAdapter )
-
-
-
-
-
-
High-level read-only ingestion interface.
-
-
-
- Notes
- Responsibilities:
-- 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.
-
Constraints:
-- This class is intentionally: Provider-agnostic, stateless beyond
- iteration scope, read-only.
-
-
Initialize the mail reader.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- adapter
- MailIntakeAdapter
-
-
-
Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
-
-
- required
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-iter_messages
-
-
-
-
iter_messages ( query : str ) -> Iterator [ MailIntakeMessage ]
-
-
-
-
-
Iterate over parsed messages matching a provider query.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- query
- str
-
-
-
-
Provider-specific query string used to filter messages.
-
-
- required
-
-
-
-
-
-
-
Yields:
-
-
-
-Name Type
- Description
-
-
-
-
-MailIntakeMessage
- MailIntakeMessage
-
-
-
Fully parsed and normalized MailIntakeMessage instances.
-
-
-
-
-
-
-
Raises:
-
-
-
-
-
-
-
-
-
-
-iter_threads
-
-
-
-
iter_threads ( query : str ) -> Iterator [ MailIntakeThread ]
-
-
-
-
-
Iterate over threads constructed from messages matching a query.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- query
- str
-
-
-
-
Provider-specific query string used to filter messages.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- Iterator [MailIntakeThread ]
-
-
-
Iterator[MailIntakeThread]:
-An iterator over MailIntakeThread instances.
-
-
-
-
-
-
-
Raises:
-
-
-
- Type
- Description
-
-
-
-
-
- `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.
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/models/index.html b/mail-intake/lib/mail_intake/models/index.html
deleted file mode 100644
index 2407626..0000000
--- a/mail-intake/lib/mail_intake/models/index.html
+++ /dev/null
@@ -1,1985 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Models - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Models
-
-
-
-
-
-
-
-mail_intake.models
-
-
-
-
-
-
-
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.
-
-
These models form the core internal data contract of the library.
-
-
Public API
-
-MailIntakeMessageMailIntakeThread
-
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeMessage
-
-
-
- dataclass
-
-
-
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 ],
-)
-
-
-
-
-
-
Canonical internal representation of a single email message.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
Attributes
-
-
-
-
-
-
-body_text
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Extracted plain-text body content of the message.
-
-
-
-
-
-
-
-
-
-from_email
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Sender email address.
-
-
-
-
-
-
-
-
-
-from_name
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Optional human-readable sender name.
-
-
-
-
-
-
-
-
-
-message_id
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Provider-specific message identifier.
-
-
-
-
-
-
-
-
-
-
raw_headers : dict [ str , str ]
-
-
-
-
-
Normalized mapping of message headers (header name → value).
-
-
-
-
-
-
-
-
-
-snippet
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Short provider-supplied preview snippet of the message.
-
-
-
-
-
-
-
-
-
-subject
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Raw subject line of the message.
-
-
-
-
-
-
-
-
-
-thread_id
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Provider-specific thread identifier to which this message belongs.
-
-
-
-
-
-
-
-
-
-timestamp
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Message timestamp as a timezone-naive UTC datetime.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-MailIntakeThread
-
-
-
- dataclass
-
-
-
MailIntakeThread (
-thread_id : str ,
-normalized_subject : str ,
-participants : set [ str ] = ... ,
-messages : list [ MailIntakeMessage ] = ... ,
-last_activity_at : datetime | None = ... ,
-)
-
-
-
-
-
-
Canonical internal representation of an email thread.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
Attributes
-
-
-
-
-
-
-last_activity_at
-
-
-
- class-attributeinstance-attribute
-
-
-
last_activity_at : datetime | None = None
-
-
-
-
-
Timestamp of the most recent message in the thread.
-
-
-
-
-
-
-
-
-
-messages
-
-
-
- class-attributeinstance-attribute
-
-
-
messages : list [ MailIntakeMessage ] = field (
-default_factory = list
-)
-
-
-
-
-
Ordered list of messages belonging to this thread.
-
-
-
-
-
-
-
-
-
-normalized_subject
-
-
-
- instance-attribute
-
-
-
normalized_subject : str
-
-
-
-
-
Normalized subject line used to group related messages.
-
-
-
-
-
-
-
-
-
-participants
-
-
-
- class-attributeinstance-attribute
-
-
-
participants : set [ str ] = field ( default_factory = set )
-
-
-
-
-
Set of unique participant email addresses observed in the thread.
-
-
-
-
-
-
-
-
-
-thread_id
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Provider-specific thread identifier.
-
-
-
-
-
Functions
-
-
-
-
-
-add_message
-
-
-
-
add_message ( message : MailIntakeMessage ) -> None
-
-
-
-
-
Add a message to the thread and update derived fields.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- message
- MailIntakeMessage
-
-
-
Parsed mail message to add to the thread.
-
-
- required
-
-
-
-
-
-
-
- Notes
- Responsibilities:
-- Appends the message to the thread.
-- Tracks unique participants.
-- Updates the last activity timestamp.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/models/message/index.html b/mail-intake/lib/mail_intake/models/message/index.html
deleted file mode 100644
index 08a7bed..0000000
--- a/mail-intake/lib/mail_intake/models/message/index.html
+++ /dev/null
@@ -1,1612 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Message - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Message
-
-
-
-
-
-
-
-mail_intake.models.message
-
-
-
-
-
-
-
Summary
-
Message domain models for Mail Intake.
-
This module defines the canonical, provider-agnostic representation
-of an individual email message as used internally by the Mail Intake
-ingestion pipeline.
-
Models in this module are safe to persist and must not contain any
-provider-specific fields or semantics.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeMessage
-
-
-
- dataclass
-
-
-
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 ],
-)
-
-
-
-
-
-
Canonical internal representation of a single email message.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
Attributes
-
-
-
-
-
-
-body_text
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Extracted plain-text body content of the message.
-
-
-
-
-
-
-
-
-
-from_email
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Sender email address.
-
-
-
-
-
-
-
-
-
-from_name
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Optional human-readable sender name.
-
-
-
-
-
-
-
-
-
-message_id
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Provider-specific message identifier.
-
-
-
-
-
-
-
-
-
-
raw_headers : dict [ str , str ]
-
-
-
-
-
Normalized mapping of message headers (header name → value).
-
-
-
-
-
-
-
-
-
-snippet
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Short provider-supplied preview snippet of the message.
-
-
-
-
-
-
-
-
-
-subject
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Raw subject line of the message.
-
-
-
-
-
-
-
-
-
-thread_id
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Provider-specific thread identifier to which this message belongs.
-
-
-
-
-
-
-
-
-
-timestamp
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Message timestamp as a timezone-naive UTC datetime.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/models/thread/index.html b/mail-intake/lib/mail_intake/models/thread/index.html
deleted file mode 100644
index 9185386..0000000
--- a/mail-intake/lib/mail_intake/models/thread/index.html
+++ /dev/null
@@ -1,1564 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Thread - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Thread
-
-
-
-
-
-
-
-mail_intake.models.thread
-
-
-
-
-
-
-
Summary
-
Thread domain models for Mail Intake.
-
This module defines the canonical, provider-agnostic representation
-of an email thread as used internally by the Mail Intake ingestion pipeline.
-
Threads group related messages and serve as the primary unit of reasoning
-for higher-level correspondence workflows.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
-MailIntakeThread
-
-
-
- dataclass
-
-
-
MailIntakeThread (
-thread_id : str ,
-normalized_subject : str ,
-participants : set [ str ] = ... ,
-messages : list [ MailIntakeMessage ] = ... ,
-last_activity_at : datetime | None = ... ,
-)
-
-
-
-
-
-
Canonical internal representation of an email thread.
-
-
-
- Notes
- Guarantees:
-- 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.
-
-
-
-
-
-
-
-
-
-
-
Attributes
-
-
-
-
-
-
-last_activity_at
-
-
-
- class-attributeinstance-attribute
-
-
-
last_activity_at : datetime | None = None
-
-
-
-
-
Timestamp of the most recent message in the thread.
-
-
-
-
-
-
-
-
-
-messages
-
-
-
- class-attributeinstance-attribute
-
-
-
messages : list [ MailIntakeMessage ] = field (
-default_factory = list
-)
-
-
-
-
-
Ordered list of messages belonging to this thread.
-
-
-
-
-
-
-
-
-
-normalized_subject
-
-
-
- instance-attribute
-
-
-
normalized_subject : str
-
-
-
-
-
Normalized subject line used to group related messages.
-
-
-
-
-
-
-
-
-
-participants
-
-
-
- class-attributeinstance-attribute
-
-
-
participants : set [ str ] = field ( default_factory = set )
-
-
-
-
-
Set of unique participant email addresses observed in the thread.
-
-
-
-
-
-
-
-
-
-thread_id
-
-
-
- instance-attribute
-
-
-
-
-
-
-
Provider-specific thread identifier.
-
-
-
-
-
Functions
-
-
-
-
-
-add_message
-
-
-
-
add_message ( message : MailIntakeMessage ) -> None
-
-
-
-
-
Add a message to the thread and update derived fields.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- message
- MailIntakeMessage
-
-
-
Parsed mail message to add to the thread.
-
-
- required
-
-
-
-
-
-
-
- Notes
- Responsibilities:
-- Appends the message to the thread.
-- Tracks unique participants.
-- Updates the last activity timestamp.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/parsers/body/index.html b/mail-intake/lib/mail_intake/parsers/body/index.html
deleted file mode 100644
index af6cc97..0000000
--- a/mail-intake/lib/mail_intake/parsers/body/index.html
+++ /dev/null
@@ -1,1311 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Body - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Body
-
-
-
-
-
-
-
-mail_intake.parsers.body
-
-
-
-
-
-
-
Summary
-
Message body extraction utilities for Mail Intake.
-
This module contains helper functions for extracting a best-effort
-plain-text body from provider-native message payloads.
-
The logic is intentionally tolerant of malformed or partial data and
-prefers human-readable text over fidelity to original formatting.
-
-
-
-
-
-
-
-
-
-
-
Classes
-
Functions
-
-
-
-
-
-extract_body
-
-
-
-
extract_body ( payload : dict [ str , Any ]) -> str
-
-
-
-
-
Extract the best-effort message body from a Gmail payload.
-
Priority:
-
-text/plaintext/html (stripped to text)Single-part body
-Empty string (if nothing usable found)
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- payload
- dict[str, Any ]
-
-
-
-
Provider-native message payload dictionary.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-str
- str
-
-
-
-
Extracted plain-text message body.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/parsers/headers/index.html b/mail-intake/lib/mail_intake/parsers/headers/index.html
deleted file mode 100644
index 66df1ca..0000000
--- a/mail-intake/lib/mail_intake/parsers/headers/index.html
+++ /dev/null
@@ -1,1444 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Headers - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Message header parsing utilities for Mail Intake.
-
This module provides helper functions for normalizing and extracting
-useful information from provider-native message headers.
-
The functions here are intentionally simple and tolerant of malformed
-or incomplete header data.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
extract_sender (
-headers : dict [ str , str ],
-) -> tuple [ str , str | None ]
-
-
-
-
-
Extract sender email and optional display name from headers.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- headers
- dict[str, str]
-
-
-
-
Normalized header dictionary as returned by parse_headers().
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- tuple[str, str | None]
-
-
-
-
tuple[str, str | None]:
-A tuple (email, name) where email is the sender email address
-and name is the display name, or None if unavailable.
-
-
-
-
-
-
-
- Notes
- Responsibilities:
-- This function parses the `From` header and attempts to extract
- sender email address and optional human-readable display name.
-
-
-
- Example
- Typical values:
-
-"John Doe <john@example.com>" -> ("john@example.com", "John Doe")"john@example.com" -> ("john@example.com", None)
-
-
-
-
-
-
-
-
-
-
parse_headers (
-raw_headers : list [ dict [ str , str ]],
-) -> dict [ str , str ]
-
-
-
-
-
Convert a list of Gmail-style headers into a normalized dict.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- raw_headers
- list[dict[str, str]]
-
-
-
-
List of header dictionaries, each containing name and value keys.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, str]
-
-
-
-
dict[str, str]:
-Dictionary mapping lowercase header names to stripped values.
-
-
-
-
-
-
-
- Notes
- Guarantees:
-- Provider payloads (such as Gmail) typically represent headers as a
- list of name/value mappings.
-- This function normalizes them into a case-insensitive dictionary
- keyed by lowercase header names.
-
-
-
- Example
- Typical usage:
-Input :
-[
-{ "name" : "From" , "value" : "John Doe <john@example.com>" },
-{ "name" : "Subject" , "value" : "Re: Interview Update" },
-]
-Output :
-{
-"from" : "John Doe <john@example.com>" ,
-"subject" : "Re: Interview Update" ,
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/parsers/index.html b/mail-intake/lib/mail_intake/parsers/index.html
deleted file mode 100644
index 260ed76..0000000
--- a/mail-intake/lib/mail_intake/parsers/index.html
+++ /dev/null
@@ -1,1663 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Parsers - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Parsers
-
-
-
-
-
-
-
-mail_intake.parsers
-
-
-
-
-
-
-
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.
-
-
This package does not:
-
-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_bodyparse_headersextract_sendernormalize_subject
-
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-extract_body
-
-
-
-
extract_body ( payload : dict [ str , Any ]) -> str
-
-
-
-
-
Extract the best-effort message body from a Gmail payload.
-
Priority:
-
-text/plaintext/html (stripped to text)Single-part body
-Empty string (if nothing usable found)
-
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- payload
- dict[str, Any ]
-
-
-
-
Provider-native message payload dictionary.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-str
- str
-
-
-
-
Extracted plain-text message body.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
extract_sender (
-headers : dict [ str , str ],
-) -> tuple [ str , str | None ]
-
-
-
-
-
Extract sender email and optional display name from headers.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- headers
- dict[str, str]
-
-
-
-
Normalized header dictionary as returned by parse_headers().
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- tuple[str, str | None]
-
-
-
-
tuple[str, str | None]:
-A tuple (email, name) where email is the sender email address
-and name is the display name, or None if unavailable.
-
-
-
-
-
-
-
- Notes
- Responsibilities:
-- This function parses the `From` header and attempts to extract
- sender email address and optional human-readable display name.
-
-
-
- Example
- Typical values:
-
-"John Doe <john@example.com>" -> ("john@example.com", "John Doe")"john@example.com" -> ("john@example.com", None)
-
-
-
-
-
-
-
-
-
-normalize_subject
-
-
-
-
normalize_subject ( subject : str ) -> str
-
-
-
-
-
Normalize an email subject for thread-level comparison.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- subject
- str
-
-
-
-
Raw subject line from a message header.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-str
- str
-
-
-
-
Normalized subject string suitable for thread grouping.
-
-
-
-
-
-
-
- Notes
- Responsibilities:
-- Strips common prefixes such as `Re:`, `Fwd:`, and `FW:`.
-- Repeats prefix stripping to handle stacked prefixes.
-- Collapses excessive whitespace.
-- Preserves original casing (no lowercasing).
-
Guarantees:
-- This function is intentionally conservative and avoids aggressive
- transformations that could alter the semantic meaning of the subject.
-
-
-
-
-
-
-
-
-
-
parse_headers (
-raw_headers : list [ dict [ str , str ]],
-) -> dict [ str , str ]
-
-
-
-
-
Convert a list of Gmail-style headers into a normalized dict.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- raw_headers
- list[dict[str, str]]
-
-
-
-
List of header dictionaries, each containing name and value keys.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
- Type
- Description
-
-
-
-
-
- dict[str, str]
-
-
-
-
dict[str, str]:
-Dictionary mapping lowercase header names to stripped values.
-
-
-
-
-
-
-
- Notes
- Guarantees:
-- Provider payloads (such as Gmail) typically represent headers as a
- list of name/value mappings.
-- This function normalizes them into a case-insensitive dictionary
- keyed by lowercase header names.
-
-
-
- Example
- Typical usage:
-Input :
-[
-{ "name" : "From" , "value" : "John Doe <john@example.com>" },
-{ "name" : "Subject" , "value" : "Re: Interview Update" },
-]
-Output :
-{
-"from" : "John Doe <john@example.com>" ,
-"subject" : "Re: Interview Update" ,
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/mail_intake/parsers/subject/index.html b/mail-intake/lib/mail_intake/parsers/subject/index.html
deleted file mode 100644
index 69b503a..0000000
--- a/mail-intake/lib/mail_intake/parsers/subject/index.html
+++ /dev/null
@@ -1,1313 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Subject - mail_intake
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Subject
-
-
-
-
-
-
-
-mail_intake.parsers.subject
-
-
-
-
-
-
-
Summary
-
Subject line normalization utilities for Mail Intake.
-
This module provides helper functions for normalizing email subject lines
-to enable reliable thread-level comparison and grouping.
-
Normalization is intentionally conservative to avoid altering semantic
-meaning while removing common reply and forward prefixes.
-
-
-
-
-
-
-
-
-
-
-
-
Functions
-
-
-
-
-
-normalize_subject
-
-
-
-
normalize_subject ( subject : str ) -> str
-
-
-
-
-
Normalize an email subject for thread-level comparison.
-
-
-
Parameters:
-
-
-
- Name
- Type
- Description
- Default
-
-
-
-
- subject
- str
-
-
-
-
Raw subject line from a message header.
-
-
- required
-
-
-
-
-
-
-
Returns:
-
-
-
-Name Type
- Description
-
-
-
-
-str
- str
-
-
-
-
Normalized subject string suitable for thread grouping.
-
-
-
-
-
-
-
- Notes
- Responsibilities:
-- Strips common prefixes such as `Re:`, `Fwd:`, and `FW:`.
-- Repeats prefix stripping to handle stacked prefixes.
-- Collapses excessive whitespace.
-- Preserves original casing (no lowercasing).
-
Guarantees:
-- This function is intentionally conservative and avoids aggressive
- transformations that could alter the semantic meaning of the subject.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/mail-intake/lib/objects.inv b/mail-intake/lib/objects.inv
index 71626ce..9bfa341 100644
Binary files a/mail-intake/lib/objects.inv and b/mail-intake/lib/objects.inv differ
diff --git a/mail-intake/lib/search/search_index.json b/mail-intake/lib/search/search_index.json
index 0fa9c07..084692a 100644
--- a/mail-intake/lib/search/search_index.json
+++ b/mail-intake/lib/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"mail_intake","text":"
"},{"location":"#mail_intake","title":"mail_intake","text":""},{"location":"#mail_intake--summary","title":"Summary","text":"
Mail Intake \u2014 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.
"},{"location":"#mail_intake--installation","title":"Installation","text":"
Install using pip:
pip install mail-intake\nOr with Poetry:
poetry add mail-intake\nMail Intake is pure Python and has no runtime dependencies beyond those required by the selected provider (for example, Google APIs for Gmail).
"},{"location":"#mail_intake--quick-start","title":"Quick Start","text":"
Minimal Gmail ingestion example (local development):
from mail_intake.ingestion import MailIntakeReader\nfrom mail_intake.adapters import MailIntakeGmailAdapter\nfrom mail_intake.auth import MailIntakeGoogleAuth\nfrom mail_intake.credentials import PickleCredentialStore\n\nstore = PickleCredentialStore(path=\"token.pickle\")\n\nauth = MailIntakeGoogleAuth(\n credentials_path=\"credentials.json\",\n store=store,\n scopes=[\"https://www.googleapis.com/auth/gmail.readonly\"],\n)\n\nadapter = MailIntakeGmailAdapter(auth_provider=auth)\nreader = MailIntakeReader(adapter)\n\nfor message in reader.iter_messages(\"from:recruiter@example.com\"):\n print(message.subject, message.from_email)\nIterating over threads:
for thread in reader.iter_threads(\"subject:Interview\"):\n print(thread.normalized_subject, len(thread.messages))\n"},{"location":"#mail_intake--architecture","title":"Architecture","text":"
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:
Layered Decoupling: Adapters handle transport, Parsers handle format normalization, and Ingestion orchestrates. Provider Agnosticism: Domain models and core logic never depend on provider-specific (e.g., Gmail) API internals. Stateless Workflows: The library functions as a read-only pipe, ensuring side-effect-free ingestion. "},{"location":"#mail_intake--public-api","title":"Public API","text":"
The supported public API consists of the following top-level modules:
mail_intake.ingestionmail_intake.adaptersmail_intake.authmail_intake.credentialsmail_intake.parsersmail_intake.modelsmail_intake.configmail_intake.exceptions Classes and functions should be imported explicitly from these modules. No individual symbols are re-exported at the package root.
"},{"location":"config/","title":"Config","text":""},{"location":"config/#mail_intake.config","title":"mail_intake.config","text":""},{"location":"config/#mail_intake.config--summary","title":"Summary","text":"
Global configuration models for Mail Intake.
This module defines the top-level configuration object used to control mail ingestion behavior across adapters, authentication providers, and ingestion workflows.
Configuration is intentionally explicit, immutable, and free of implicit environment reads to ensure predictability and testability.
"},{"location":"config/#mail_intake.config-classes","title":"Classes","text":""},{"location":"config/#mail_intake.config.MailIntakeConfig","title":"MailIntakeConfig
dataclass","text":"
MailIntakeConfig(\n provider: str = ...,\n user_id: str = ...,\n readonly: bool = ...,\n credentials_path: str | None = ...,\n token_path: str | None = ...,\n)\nGlobal configuration for mail-intake.
Notes
Guarantees:
- 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.\n"},{"location":"config/#mail_intake.config.MailIntakeConfig-attributes","title":"Attributes","text":""},{"location":"config/#mail_intake.config.MailIntakeConfig.credentials_path","title":"credentials_path
class-attribute instance-attribute","text":"
credentials_path: str | None = None\nOptional path to provider credentials configuration.
"},{"location":"config/#mail_intake.config.MailIntakeConfig.provider","title":"provider
class-attribute instance-attribute","text":"
provider: str = 'gmail'\nIdentifier of the mail provider to use (e.g., \"gmail\").
"},{"location":"config/#mail_intake.config.MailIntakeConfig.readonly","title":"readonly
class-attribute instance-attribute","text":"
readonly: bool = True\nWhether ingestion should operate in read-only mode.
"},{"location":"config/#mail_intake.config.MailIntakeConfig.token_path","title":"token_path
class-attribute instance-attribute","text":"
token_path: str | None = None\nOptional path to persisted authentication tokens.
"},{"location":"config/#mail_intake.config.MailIntakeConfig.user_id","title":"user_id
class-attribute instance-attribute","text":"
user_id: str = 'me'\nProvider-specific user identifier. Defaults to the authenticated user.
"},{"location":"exceptions/","title":"Exceptions","text":""},{"location":"exceptions/#mail_intake.exceptions","title":"mail_intake.exceptions","text":""},{"location":"exceptions/#mail_intake.exceptions--summary","title":"Summary","text":"
Exception hierarchy for Mail Intake.
This module defines the canonical exception types used throughout the Mail Intake library.
All library-raised errors derive from MailIntakeError. Consumers are encouraged to catch this base type (or specific subclasses) rather than provider-specific or third-party exceptions.
"},{"location":"exceptions/#mail_intake.exceptions-classes","title":"Classes","text":""},{"location":"exceptions/#mail_intake.exceptions.MailIntakeAdapterError","title":"MailIntakeAdapterError","text":"
Bases: MailIntakeError
Errors raised by mail provider adapters.
Notes
Lifecycle:
- Raised when a provider adapter encounters API errors, transport\n failures, or invalid provider responses.\n"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeAuthError","title":"MailIntakeAuthError","text":"
Bases: MailIntakeError
Authentication and credential-related failures.
Notes
Lifecycle:
- Raised when authentication providers are unable to acquire,\n refresh, or persist valid credentials.\n"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeError","title":"MailIntakeError","text":"
Bases: Exception
Base exception for all Mail Intake errors.
Notes
Guarantees:
- 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\n"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeParsingError","title":"MailIntakeParsingError","text":"
Bases: MailIntakeError
Errors encountered while parsing message content.
Notes
Lifecycle:
- Raised when raw provider payloads cannot be interpreted or\n normalized into internal domain models.\n"},{"location":"adapters/","title":"Adapters","text":""},{"location":"adapters/#mail_intake.adapters","title":"mail_intake.adapters","text":""},{"location":"adapters/#mail_intake.adapters--summary","title":"Summary","text":"
Mail provider adapter implementations for Mail Intake.
This package contains adapter-layer implementations responsible for 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. Provider-specific logic must not leak outside of adapter implementations. All parsings, normalizations, and transformations must be handled by downstream components.
"},{"location":"adapters/#mail_intake.adapters--public-api","title":"Public API","text":"
MailIntakeAdapterMailIntakeGmailAdapter "},{"location":"adapters/#mail_intake.adapters-classes","title":"Classes","text":""},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter","title":"MailIntakeAdapter","text":"
Bases: ABC
Base adapter interface for mail providers.
Notes
Guarantees:
- Discover messages matching a query.\n- Retrieve full message payloads.\n- Retrieve full thread payloads.\nLifecycle:
- Adapters are intentionally read-only and must not mutate provider state.\n"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter-functions","title":"Functions","text":""},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_message","title":"fetch_message
abstractmethod","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full raw message by message identifier.
Parameters:
Name Type Description Default
message_id str Provider-specific message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native message payload (e.g., Gmail message JSON structure).
"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_thread","title":"fetch_thread
abstractmethod","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full raw thread by thread identifier.
Parameters:
Name Type Description Default
thread_id str Provider-specific thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native thread payload.
"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs
abstractmethod","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over lightweight message references matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[dict[str, str]] Iterator[dict[str, str]]: An iterator over lightweight message reference dictionaries.
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message and thread identifiers.
Notes
Guarantees:
- Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n Example
Typical yield:
{\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n}\n"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"
MailIntakeGmailAdapter(\n auth_provider: MailIntakeAuthProvider[Any],\n user_id: str = \"me\",\n)\n Bases: MailIntakeAdapter
Gmail read-only adapter.
This adapter implements the MailIntakeAdapter interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.
Notes
Responsibilities:
- This class is the ONLY place where `googleapiclient` is imported.\n- Gmail REST semantics are known.\n- `.execute()` is called.\nConstraints:
- Must remain thin and imperative.\n- Must not perform parsing or interpretation.\n- Must not expose Gmail-specific types beyond this class.\nInitialize the Gmail adapter.
Parameters:
Name Type Description Default
auth_provider MailIntakeAuthProvider Authentication provider capable of supplying valid Gmail API credentials.
required
user_id str Gmail user identifier. Defaults to \"me\".
'me'"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter-attributes","title":"Attributes","text":""},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.service","title":"service
property","text":"
service: Any\nLazily initialize and return the Gmail API service client.
Raises:
Type Description
MailIntakeAdapterError If the Gmail service cannot be initialized.
"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter-functions","title":"Functions","text":""},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full Gmail message by message ID.
Parameters:
Name Type Description Default
message_id str Gmail message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail message payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full Gmail thread by thread ID.
Parameters:
Name Type Description Default
thread_id str Gmail thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail thread payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over message references matching the query.
Parameters:
Name Type Description Default
query str Gmail search query string.
required
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message_id and thread_id.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/base/","title":"Base","text":""},{"location":"adapters/base/#mail_intake.adapters.base","title":"mail_intake.adapters.base","text":""},{"location":"adapters/base/#mail_intake.adapters.base--summary","title":"Summary","text":"
Mail provider adapter contracts for Mail Intake.
This module defines the provider-agnostic adapter interface used for read-only mail ingestion.
Adapters encapsulate all provider-specific access logic and expose a minimal, normalized contract to the rest of the system. No provider-specific types or semantics should leak beyond implementations of this interface.
"},{"location":"adapters/base/#mail_intake.adapters.base-classes","title":"Classes","text":""},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter","title":"MailIntakeAdapter","text":"
Bases: ABC
Base adapter interface for mail providers.
Notes
Guarantees:
- Discover messages matching a query.\n- Retrieve full message payloads.\n- Retrieve full thread payloads.\nLifecycle:
- Adapters are intentionally read-only and must not mutate provider state.\n"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter-functions","title":"Functions","text":""},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_message","title":"fetch_message
abstractmethod","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full raw message by message identifier.
Parameters:
Name Type Description Default
message_id str Provider-specific message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native message payload (e.g., Gmail message JSON structure).
"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_thread","title":"fetch_thread
abstractmethod","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full raw thread by thread identifier.
Parameters:
Name Type Description Default
thread_id str Provider-specific thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native thread payload.
"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs
abstractmethod","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over lightweight message references matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[dict[str, str]] Iterator[dict[str, str]]: An iterator over lightweight message reference dictionaries.
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message and thread identifiers.
Notes
Guarantees:
- Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n Example
Typical yield:
{\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n}\n"},{"location":"adapters/gmail/","title":"Gmail","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail","title":"mail_intake.adapters.gmail","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail--summary","title":"Summary","text":"
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. All Gmail-specific behavior must be strictly contained within this module.
"},{"location":"adapters/gmail/#mail_intake.adapters.gmail-classes","title":"Classes","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"
MailIntakeGmailAdapter(\n auth_provider: MailIntakeAuthProvider[Any],\n user_id: str = \"me\",\n)\n Bases: MailIntakeAdapter
Gmail read-only adapter.
This adapter implements the MailIntakeAdapter interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.
Notes
Responsibilities:
- This class is the ONLY place where `googleapiclient` is imported.\n- Gmail REST semantics are known.\n- `.execute()` is called.\nConstraints:
- Must remain thin and imperative.\n- Must not perform parsing or interpretation.\n- Must not expose Gmail-specific types beyond this class.\nInitialize the Gmail adapter.
Parameters:
Name Type Description Default
auth_provider MailIntakeAuthProvider Authentication provider capable of supplying valid Gmail API credentials.
required
user_id str Gmail user identifier. Defaults to \"me\".
'me'"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter-attributes","title":"Attributes","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.service","title":"service
property","text":"
service: Any\nLazily initialize and return the Gmail API service client.
Raises:
Type Description
MailIntakeAdapterError If the Gmail service cannot be initialized.
"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter-functions","title":"Functions","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full Gmail message by message ID.
Parameters:
Name Type Description Default
message_id str Gmail message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail message payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full Gmail thread by thread ID.
Parameters:
Name Type Description Default
thread_id str Gmail thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail thread payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over message references matching the query.
Parameters:
Name Type Description Default
query str Gmail search query string.
required
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message_id and thread_id.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"auth/","title":"Auth","text":""},{"location":"auth/#mail_intake.auth","title":"mail_intake.auth","text":""},{"location":"auth/#mail_intake.auth--summary","title":"Summary","text":"
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. 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. Consumers should depend on the abstract interface and use concrete implementations only where explicitly required.
"},{"location":"auth/#mail_intake.auth--public-api","title":"Public API","text":"
MailIntakeAuthProviderMailIntakeGoogleAuth "},{"location":"auth/#mail_intake.auth-classes","title":"Classes","text":""},{"location":"auth/#mail_intake.auth.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"
Bases: ABC, Generic[T]
Abstract base class for authentication providers.
This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.
Notes
Responsibilities:
- 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.\nConstraints:
- 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.\n"},{"location":"auth/#mail_intake.auth.MailIntakeAuthProvider-functions","title":"Functions","text":""},{"location":"auth/#mail_intake.auth.MailIntakeAuthProvider.get_credentials","title":"get_credentials
abstractmethod","text":"
get_credentials() -> T\nRetrieve valid, provider-specific credentials.
Returns:
Name Type Description
T T Credentials of type T suitable for immediate use by the corresponding mail adapter.
Raises:
Type Description
Exception An authentication-specific exception indicating that credentials could not be obtained or validated.
Notes
Guarantees:
- 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.\n"},{"location":"auth/#mail_intake.auth.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"
MailIntakeGoogleAuth(\n credentials_path: str,\n store: CredentialStore[Any],\n scopes: Sequence[str],\n)\n Bases: MailIntakeAuthProvider
Google OAuth provider for Gmail access.
This provider implements the MailIntakeAuthProvider interface using Google's OAuth 2.0 flow and credential management libraries.
Notes
Responsibilities:
- 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.\nGuarantees:
- This class is synchronous by design and maintains a minimal\n internal state.\nInitialize the Google authentication provider.
Parameters:
Name Type Description Default
credentials_path str Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
required
store CredentialStore[Credentials] Credential store responsible for persisting and retrieving Google OAuth credentials.
required
scopes Sequence[str] OAuth scopes required for Gmail access.
required"},{"location":"auth/#mail_intake.auth.MailIntakeGoogleAuth-functions","title":"Functions","text":""},{"location":"auth/#mail_intake.auth.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"
get_credentials() -> Any\nRetrieve valid Google OAuth credentials.
Returns:
Name Type Description
Credentials Any A google.oauth2.credentials.Credentials instance suitable for use with Google API clients.
Raises:
Type Description
MailIntakeAuthError If credentials cannot be loaded, refreshed, or obtained via interactive authentication.
Notes
Lifecycle:
- 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.\n"},{"location":"auth/base/","title":"Base","text":""},{"location":"auth/base/#mail_intake.auth.base","title":"mail_intake.auth.base","text":""},{"location":"auth/base/#mail_intake.auth.base--summary","title":"Summary","text":"
Authentication provider contracts for Mail Intake.
This module defines the authentication abstraction layer used by mail adapters to obtain provider-specific credentials.
Authentication concerns are intentionally decoupled from adapter logic. Adapters depend only on this interface and must not be aware of how credentials are acquired, refreshed, or persisted.
"},{"location":"auth/base/#mail_intake.auth.base-classes","title":"Classes","text":""},{"location":"auth/base/#mail_intake.auth.base.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"
Bases: ABC, Generic[T]
Abstract base class for authentication providers.
This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.
Notes
Responsibilities:
- 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.\nConstraints:
- 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.\n"},{"location":"auth/base/#mail_intake.auth.base.MailIntakeAuthProvider-functions","title":"Functions","text":""},{"location":"auth/base/#mail_intake.auth.base.MailIntakeAuthProvider.get_credentials","title":"get_credentials
abstractmethod","text":"
get_credentials() -> T\nRetrieve valid, provider-specific credentials.
Returns:
Name Type Description
T T Credentials of type T suitable for immediate use by the corresponding mail adapter.
Raises:
Type Description
Exception An authentication-specific exception indicating that credentials could not be obtained or validated.
Notes
Guarantees:
- 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.\n"},{"location":"auth/google/","title":"Google","text":""},{"location":"auth/google/#mail_intake.auth.google","title":"mail_intake.auth.google","text":""},{"location":"auth/google/#mail_intake.auth.google--summary","title":"Summary","text":"
Google authentication provider implementation for Mail Intake.
This module provides a Google OAuth\u2013based 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. No Google authentication details should leak outside this module.
"},{"location":"auth/google/#mail_intake.auth.google-classes","title":"Classes","text":""},{"location":"auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"
MailIntakeGoogleAuth(\n credentials_path: str,\n store: CredentialStore[Any],\n scopes: Sequence[str],\n)\n Bases: MailIntakeAuthProvider
Google OAuth provider for Gmail access.
This provider implements the MailIntakeAuthProvider interface using Google's OAuth 2.0 flow and credential management libraries.
Notes
Responsibilities:
- 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.\nGuarantees:
- This class is synchronous by design and maintains a minimal\n internal state.\nInitialize the Google authentication provider.
Parameters:
Name Type Description Default
credentials_path str Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
required
store CredentialStore[Credentials] Credential store responsible for persisting and retrieving Google OAuth credentials.
required
scopes Sequence[str] OAuth scopes required for Gmail access.
required"},{"location":"auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth-functions","title":"Functions","text":""},{"location":"auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"
get_credentials() -> Any\nRetrieve valid Google OAuth credentials.
Returns:
Name Type Description
Credentials Any A google.oauth2.credentials.Credentials instance suitable for use with Google API clients.
Raises:
Type Description
MailIntakeAuthError If credentials cannot be loaded, refreshed, or obtained via interactive authentication.
Notes
Lifecycle:
- 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.\n"},{"location":"credentials/","title":"Credentials","text":""},{"location":"credentials/#mail_intake.credentials","title":"mail_intake.credentials","text":""},{"location":"credentials/#mail_intake.credentials--summary","title":"Summary","text":"
Credential persistence interfaces and implementations for Mail Intake.
This package defines the abstractions and concrete implementations used to persist authentication credentials across Mail Intake components.
The credential persistence layer is intentionally decoupled from authentication logic. Authentication providers are responsible for 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\u2013based 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.
"},{"location":"credentials/#mail_intake.credentials--public-api","title":"Public API","text":"
CredentialStorePickleCredentialStoreRedisCredentialStore "},{"location":"credentials/#mail_intake.credentials-classes","title":"Classes","text":""},{"location":"credentials/#mail_intake.credentials.CredentialStore","title":"CredentialStore","text":"
Bases: ABC, Generic[T]
Abstract base class defining a generic persistence interface.
Used for authentication credentials across different backends.
Notes
Responsibilities:
- Provide persistent storage separating life-cycle management from\n storage mechanics.\n- Keep implementation focused only on persistence.\nConstraints:
- 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.\n"},{"location":"credentials/#mail_intake.credentials.CredentialStore-functions","title":"Functions","text":""},{"location":"credentials/#mail_intake.credentials.CredentialStore.clear","title":"clear
abstractmethod","text":"
clear() -> None\nRemove any persisted credentials from the store.
Notes
Lifecycle:
- 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\nGuarantees:
- Implementations should treat this operation as idempotent\n"},{"location":"credentials/#mail_intake.credentials.CredentialStore.load","title":"load
abstractmethod","text":"
load() -> T | None\nLoad previously persisted credentials.
Returns:
Type Description
T | 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\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.\n"},{"location":"credentials/#mail_intake.credentials.CredentialStore.save","title":"save
abstractmethod","text":"
save(credentials: T) -> None\nPersist credentials to the underlying storage backend.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required 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\nResponsibilities:
- Ensuring durability appropriate to the deployment context\n- Applying encryption or access controls where required\n- Overwriting any previously stored credentials\n"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore","title":"PickleCredentialStore","text":"
PickleCredentialStore(path: str)\n Bases: CredentialStore[T]
Filesystem-backed credential store using pickle serialization.
This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.
Notes
Guarantees:
- Stores credentials on the local filesystem.\n- Uses `pickle` for serialization and deserialization.\n- Does not provide encryption, locking, or concurrency guarantees.\nConstraints:
- Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.\nInitialize a pickle-backed credential store.
Parameters:
Name Type Description Default
path str Filesystem path where credentials will be stored. The file will be created or overwritten as needed.
required"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore-functions","title":"Functions","text":""},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove persisted credentials from the local filesystem.
Notes
Lifecycle:
- This method deletes the credential file if it exists and should be treated as an idempotent operation\n"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from the local filesystem.
Returns:
Type Description
T | 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\n deserialized, this method returns `None`.\n- The store does not attempt to validate or interpret the\n returned credentials.\n"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to the local filesystem.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- Any previously stored credentials at the configured path are overwritten\n"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore","title":"RedisCredentialStore","text":"
RedisCredentialStore(\n redis_client: Any,\n key: str,\n serialize: Callable[[T], bytes],\n deserialize: Callable[[bytes], T],\n ttl_seconds: int | None = None,\n)\n Bases: CredentialStore[T]
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.
Notes
Responsibilities:
- 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.\nGuarantees:
- 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.\nInitialize a Redis-backed credential store.
Parameters:
Name Type Description Default
redis_client Any Initialized Redis client instance used for persistence.
required
key str Storage key under which credentials are persisted.
required
serialize Callable[[T], bytes] Callable that encodes credentials to bytes for storage.
required
deserialize Callable[[bytes], T] Callable that decodes stored bytes back into credentials.
required
ttl_seconds int | None Optional time-to-live in seconds after which stored credentials expire automatically. None disables expiry.
None"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore-functions","title":"Functions","text":""},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove stored credentials from Redis.
Notes
Lifecycle:
- This operation deletes the configured Redis key if it exists\n- Implementations should treat this method as idempotent\n"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from Redis.
Returns:
Type Description
T | 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\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.\n"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to Redis.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- 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\n"},{"location":"credentials/pickle/","title":"Pickle","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle","title":"mail_intake.credentials.pickle","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle--summary","title":"Summary","text":"
Local filesystem\u2013based credential persistence for Mail Intake.
This module provides a file-backed implementation of the CredentialStore abstraction using Python's pickle module.
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 serialization, this implementation is not suitable for distributed or untrusted environments.
"},{"location":"credentials/pickle/#mail_intake.credentials.pickle-classes","title":"Classes","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore","title":"PickleCredentialStore","text":"
PickleCredentialStore(path: str)\n Bases: CredentialStore[T]
Filesystem-backed credential store using pickle serialization.
This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.
Notes
Guarantees:
- Stores credentials on the local filesystem.\n- Uses `pickle` for serialization and deserialization.\n- Does not provide encryption, locking, or concurrency guarantees.\nConstraints:
- Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.\nInitialize a pickle-backed credential store.
Parameters:
Name Type Description Default
path str Filesystem path where credentials will be stored. The file will be created or overwritten as needed.
required"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore-functions","title":"Functions","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove persisted credentials from the local filesystem.
Notes
Lifecycle:
- This method deletes the credential file if it exists and should be treated as an idempotent operation\n"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from the local filesystem.
Returns:
Type Description
T | 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\n deserialized, this method returns `None`.\n- The store does not attempt to validate or interpret the\n returned credentials.\n"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to the local filesystem.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- Any previously stored credentials at the configured path are overwritten\n"},{"location":"credentials/redis/","title":"Redis","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis","title":"mail_intake.credentials.redis","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis--summary","title":"Summary","text":"
Redis-backed credential persistence for Mail Intake.
This module provides a Redis-based implementation of the CredentialStore abstraction, enabling credential persistence across distributed and horizontally scaled deployments.
The Redis credential store is designed for environments where authentication credentials must be shared safely across multiple 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. This module is responsible solely for persistence concerns. Credential validation, refresh, rotation, and acquisition remain the responsibility of authentication provider implementations.
"},{"location":"credentials/redis/#mail_intake.credentials.redis-classes","title":"Classes","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore","title":"RedisCredentialStore","text":"
RedisCredentialStore(\n redis_client: Any,\n key: str,\n serialize: Callable[[T], bytes],\n deserialize: Callable[[bytes], T],\n ttl_seconds: int | None = None,\n)\n Bases: CredentialStore[T]
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.
Notes
Responsibilities:
- 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.\nGuarantees:
- 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.\nInitialize a Redis-backed credential store.
Parameters:
Name Type Description Default
redis_client Any Initialized Redis client instance used for persistence.
required
key str Storage key under which credentials are persisted.
required
serialize Callable[[T], bytes] Callable that encodes credentials to bytes for storage.
required
deserialize Callable[[bytes], T] Callable that decodes stored bytes back into credentials.
required
ttl_seconds int | None Optional time-to-live in seconds after which stored credentials expire automatically. None disables expiry.
None"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore-functions","title":"Functions","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove stored credentials from Redis.
Notes
Lifecycle:
- This operation deletes the configured Redis key if it exists\n- Implementations should treat this method as idempotent\n"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from Redis.
Returns:
Type Description
T | 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\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.\n"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to Redis.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- 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\n"},{"location":"credentials/store/","title":"Store","text":""},{"location":"credentials/store/#mail_intake.credentials.store","title":"mail_intake.credentials.store","text":""},{"location":"credentials/store/#mail_intake.credentials.store--summary","title":"Summary","text":"
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 between credential lifecycle management and credential storage. Authentication providers are responsible for acquiring, validating, refreshing, and revoking credentials, while concrete store implementations are responsible solely for persistence concerns.
By remaining agnostic to credential structure, serialization format, and storage backend, this module enables multiple persistence strategies\u2014such as local files, in-memory caches, distributed stores, or secrets managers\u2014without coupling authentication logic to any specific storage mechanism.
"},{"location":"credentials/store/#mail_intake.credentials.store-classes","title":"Classes","text":""},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore","title":"CredentialStore","text":"
Bases: ABC, Generic[T]
Abstract base class defining a generic persistence interface.
Used for authentication credentials across different backends.
Notes
Responsibilities:
- Provide persistent storage separating life-cycle management from\n storage mechanics.\n- Keep implementation focused only on persistence.\nConstraints:
- 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.\n"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore-functions","title":"Functions","text":""},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.clear","title":"clear
abstractmethod","text":"
clear() -> None\nRemove any persisted credentials from the store.
Notes
Lifecycle:
- 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\nGuarantees:
- Implementations should treat this operation as idempotent\n"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.load","title":"load
abstractmethod","text":"
load() -> T | None\nLoad previously persisted credentials.
Returns:
Type Description
T | 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\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.\n"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.save","title":"save
abstractmethod","text":"
save(credentials: T) -> None\nPersist credentials to the underlying storage backend.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required 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\nResponsibilities:
- Ensuring durability appropriate to the deployment context\n- Applying encryption or access controls where required\n- Overwriting any previously stored credentials\n"},{"location":"ingestion/","title":"Ingestion","text":""},{"location":"ingestion/#mail_intake.ingestion","title":"mail_intake.ingestion","text":""},{"location":"ingestion/#mail_intake.ingestion--summary","title":"Summary","text":"
Mail ingestion orchestration for Mail Intake.
This package contains high-level ingestion components responsible for coordinating mail retrieval, parsing, normalization, and model construction.
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. Consumers are expected to construct a mail adapter and pass it to the ingestion layer to begin processing messages and threads.
"},{"location":"ingestion/#mail_intake.ingestion--public-api","title":"Public API","text":"
"},{"location":"ingestion/#mail_intake.ingestion-classes","title":"Classes","text":""},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader","title":"MailIntakeReader","text":"
MailIntakeReader(adapter: MailIntakeAdapter)\nHigh-level read-only ingestion interface.
Notes
Responsibilities:
- 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.\nConstraints:
- This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.\nInitialize the mail reader.
Parameters:
Name Type Description Default
adapter MailIntakeAdapter Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
required"},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader-functions","title":"Functions","text":""},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader.iter_messages","title":"iter_messages","text":"
iter_messages(query: str) -> Iterator[MailIntakeMessage]\nIterate over parsed messages matching a provider query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Yields:
Name Type Description
MailIntakeMessage MailIntakeMessage Fully parsed and normalized MailIntakeMessage instances.
Raises:
Type Description
MailIntakeParsingError If a message cannot be parsed.
"},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader.iter_threads","title":"iter_threads","text":"
iter_threads(query: str) -> Iterator[MailIntakeThread]\nIterate over threads constructed from messages matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[MailIntakeThread] Iterator[MailIntakeThread]: An iterator over MailIntakeThread instances.
Raises:
Type Description
`MailIntakeParsingError` If a message cannot be parsed.
Notes
Guarantees:
- Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages.\n"},{"location":"ingestion/reader/","title":"Reader","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader","title":"mail_intake.ingestion.reader","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader--summary","title":"Summary","text":"
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. No provider-specific logic or API semantics are permitted in this layer.
"},{"location":"ingestion/reader/#mail_intake.ingestion.reader-classes","title":"Classes","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader","title":"MailIntakeReader","text":"
MailIntakeReader(adapter: MailIntakeAdapter)\nHigh-level read-only ingestion interface.
Notes
Responsibilities:
- 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.\nConstraints:
- This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.\nInitialize the mail reader.
Parameters:
Name Type Description Default
adapter MailIntakeAdapter Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
required"},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader-functions","title":"Functions","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_messages","title":"iter_messages","text":"
iter_messages(query: str) -> Iterator[MailIntakeMessage]\nIterate over parsed messages matching a provider query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Yields:
Name Type Description
MailIntakeMessage MailIntakeMessage Fully parsed and normalized MailIntakeMessage instances.
Raises:
Type Description
MailIntakeParsingError If a message cannot be parsed.
"},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_threads","title":"iter_threads","text":"
iter_threads(query: str) -> Iterator[MailIntakeThread]\nIterate over threads constructed from messages matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[MailIntakeThread] Iterator[MailIntakeThread]: An iterator over MailIntakeThread instances.
Raises:
Type Description
`MailIntakeParsingError` If a message cannot be parsed.
Notes
Guarantees:
- Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages.\n"},{"location":"ingestion/reader/#mail_intake.ingestion.reader-functions","title":"Functions","text":""},{"location":"mail_intake/","title":"Mail Intake","text":"
Adapters Auth Config Credentials Exceptions Ingestion Models Parsers "},{"location":"mail_intake/#mail_intake","title":"mail_intake","text":""},{"location":"mail_intake/#mail_intake--summary","title":"Summary","text":"
Mail Intake \u2014 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.
"},{"location":"mail_intake/#mail_intake--installation","title":"Installation","text":"
Install using pip:
pip install mail-intake\nOr with Poetry:
poetry add mail-intake\nMail Intake is pure Python and has no runtime dependencies beyond those required by the selected provider (for example, Google APIs for Gmail).
"},{"location":"mail_intake/#mail_intake--quick-start","title":"Quick Start","text":"
Minimal Gmail ingestion example (local development):
from mail_intake.ingestion import MailIntakeReader\nfrom mail_intake.adapters import MailIntakeGmailAdapter\nfrom mail_intake.auth import MailIntakeGoogleAuth\nfrom mail_intake.credentials import PickleCredentialStore\n\nstore = PickleCredentialStore(path=\"token.pickle\")\n\nauth = MailIntakeGoogleAuth(\n credentials_path=\"credentials.json\",\n store=store,\n scopes=[\"https://www.googleapis.com/auth/gmail.readonly\"],\n)\n\nadapter = MailIntakeGmailAdapter(auth_provider=auth)\nreader = MailIntakeReader(adapter)\n\nfor message in reader.iter_messages(\"from:recruiter@example.com\"):\n print(message.subject, message.from_email)\nIterating over threads:
for thread in reader.iter_threads(\"subject:Interview\"):\n print(thread.normalized_subject, len(thread.messages))\n"},{"location":"mail_intake/#mail_intake--architecture","title":"Architecture","text":"
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:
Layered Decoupling: Adapters handle transport, Parsers handle format normalization, and Ingestion orchestrates. Provider Agnosticism: Domain models and core logic never depend on provider-specific (e.g., Gmail) API internals. Stateless Workflows: The library functions as a read-only pipe, ensuring side-effect-free ingestion. "},{"location":"mail_intake/#mail_intake--public-api","title":"Public API","text":"
The supported public API consists of the following top-level modules:
mail_intake.ingestionmail_intake.adaptersmail_intake.authmail_intake.credentialsmail_intake.parsersmail_intake.modelsmail_intake.configmail_intake.exceptions Classes and functions should be imported explicitly from these modules. No individual symbols are re-exported at the package root.
"},{"location":"mail_intake/config/","title":"Config","text":""},{"location":"mail_intake/config/#mail_intake.config","title":"mail_intake.config","text":""},{"location":"mail_intake/config/#mail_intake.config--summary","title":"Summary","text":"
Global configuration models for Mail Intake.
This module defines the top-level configuration object used to control mail ingestion behavior across adapters, authentication providers, and ingestion workflows.
Configuration is intentionally explicit, immutable, and free of implicit environment reads to ensure predictability and testability.
"},{"location":"mail_intake/config/#mail_intake.config-classes","title":"Classes","text":""},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig","title":"MailIntakeConfig
dataclass","text":"
MailIntakeConfig(\n provider: str = ...,\n user_id: str = ...,\n readonly: bool = ...,\n credentials_path: str | None = ...,\n token_path: str | None = ...,\n)\nGlobal configuration for mail-intake.
Notes
Guarantees:
- 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.\n"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig-attributes","title":"Attributes","text":""},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.credentials_path","title":"credentials_path
class-attribute instance-attribute","text":"
credentials_path: str | None = None\nOptional path to provider credentials configuration.
"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.provider","title":"provider
class-attribute instance-attribute","text":"
provider: str = 'gmail'\nIdentifier of the mail provider to use (e.g., \"gmail\").
"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.readonly","title":"readonly
class-attribute instance-attribute","text":"
readonly: bool = True\nWhether ingestion should operate in read-only mode.
"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.token_path","title":"token_path
class-attribute instance-attribute","text":"
token_path: str | None = None\nOptional path to persisted authentication tokens.
"},{"location":"mail_intake/config/#mail_intake.config.MailIntakeConfig.user_id","title":"user_id
class-attribute instance-attribute","text":"
user_id: str = 'me'\nProvider-specific user identifier. Defaults to the authenticated user.
"},{"location":"mail_intake/exceptions/","title":"Exceptions","text":""},{"location":"mail_intake/exceptions/#mail_intake.exceptions","title":"mail_intake.exceptions","text":""},{"location":"mail_intake/exceptions/#mail_intake.exceptions--summary","title":"Summary","text":"
Exception hierarchy for Mail Intake.
This module defines the canonical exception types used throughout the Mail Intake library.
All library-raised errors derive from MailIntakeError. Consumers are encouraged to catch this base type (or specific subclasses) rather than provider-specific or third-party exceptions.
"},{"location":"mail_intake/exceptions/#mail_intake.exceptions-classes","title":"Classes","text":""},{"location":"mail_intake/exceptions/#mail_intake.exceptions.MailIntakeAdapterError","title":"MailIntakeAdapterError","text":"
Bases: MailIntakeError
Errors raised by mail provider adapters.
Notes
Lifecycle:
- Raised when a provider adapter encounters API errors, transport\n failures, or invalid provider responses.\n"},{"location":"mail_intake/exceptions/#mail_intake.exceptions.MailIntakeAuthError","title":"MailIntakeAuthError","text":"
Bases: MailIntakeError
Authentication and credential-related failures.
Notes
Lifecycle:
- Raised when authentication providers are unable to acquire,\n refresh, or persist valid credentials.\n"},{"location":"mail_intake/exceptions/#mail_intake.exceptions.MailIntakeError","title":"MailIntakeError","text":"
Bases: Exception
Base exception for all Mail Intake errors.
Notes
Guarantees:
- 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\n"},{"location":"mail_intake/exceptions/#mail_intake.exceptions.MailIntakeParsingError","title":"MailIntakeParsingError","text":"
Bases: MailIntakeError
Errors encountered while parsing message content.
Notes
Lifecycle:
- Raised when raw provider payloads cannot be interpreted or\n normalized into internal domain models.\n"},{"location":"mail_intake/adapters/","title":"Adapters","text":"
"},{"location":"mail_intake/adapters/#mail_intake.adapters","title":"mail_intake.adapters","text":""},{"location":"mail_intake/adapters/#mail_intake.adapters--summary","title":"Summary","text":"
Mail provider adapter implementations for Mail Intake.
This package contains adapter-layer implementations responsible for 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. Provider-specific logic must not leak outside of adapter implementations. All parsings, normalizations, and transformations must be handled by downstream components.
"},{"location":"mail_intake/adapters/#mail_intake.adapters--public-api","title":"Public API","text":"
MailIntakeAdapterMailIntakeGmailAdapter "},{"location":"mail_intake/adapters/#mail_intake.adapters-classes","title":"Classes","text":""},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter","title":"MailIntakeAdapter","text":"
Bases: ABC
Base adapter interface for mail providers.
Notes
Guarantees:
- Discover messages matching a query.\n- Retrieve full message payloads.\n- Retrieve full thread payloads.\nLifecycle:
- Adapters are intentionally read-only and must not mutate provider state.\n"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter-functions","title":"Functions","text":""},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_message","title":"fetch_message
abstractmethod","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full raw message by message identifier.
Parameters:
Name Type Description Default
message_id str Provider-specific message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native message payload (e.g., Gmail message JSON structure).
"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_thread","title":"fetch_thread
abstractmethod","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full raw thread by thread identifier.
Parameters:
Name Type Description Default
thread_id str Provider-specific thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native thread payload.
"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs
abstractmethod","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over lightweight message references matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[dict[str, str]] Iterator[dict[str, str]]: An iterator over lightweight message reference dictionaries.
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message and thread identifiers.
Notes
Guarantees:
- Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n Example
Typical yield:
{\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n}\n"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"
MailIntakeGmailAdapter(\n auth_provider: MailIntakeAuthProvider[Any],\n user_id: str = \"me\",\n)\n Bases: MailIntakeAdapter
Gmail read-only adapter.
This adapter implements the MailIntakeAdapter interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.
Notes
Responsibilities:
- This class is the ONLY place where `googleapiclient` is imported.\n- Gmail REST semantics are known.\n- `.execute()` is called.\nConstraints:
- Must remain thin and imperative.\n- Must not perform parsing or interpretation.\n- Must not expose Gmail-specific types beyond this class.\nInitialize the Gmail adapter.
Parameters:
Name Type Description Default
auth_provider MailIntakeAuthProvider Authentication provider capable of supplying valid Gmail API credentials.
required
user_id str Gmail user identifier. Defaults to \"me\".
'me'"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter-attributes","title":"Attributes","text":""},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter.service","title":"service
property","text":"
service: Any\nLazily initialize and return the Gmail API service client.
Raises:
Type Description
MailIntakeAdapterError If the Gmail service cannot be initialized.
"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter-functions","title":"Functions","text":""},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full Gmail message by message ID.
Parameters:
Name Type Description Default
message_id str Gmail message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail message payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full Gmail thread by thread ID.
Parameters:
Name Type Description Default
thread_id str Gmail thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail thread payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"mail_intake/adapters/#mail_intake.adapters.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over message references matching the query.
Parameters:
Name Type Description Default
query str Gmail search query string.
required
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message_id and thread_id.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"mail_intake/adapters/base/","title":"Base","text":""},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base","title":"mail_intake.adapters.base","text":""},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base--summary","title":"Summary","text":"
Mail provider adapter contracts for Mail Intake.
This module defines the provider-agnostic adapter interface used for read-only mail ingestion.
Adapters encapsulate all provider-specific access logic and expose a minimal, normalized contract to the rest of the system. No provider-specific types or semantics should leak beyond implementations of this interface.
"},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base-classes","title":"Classes","text":""},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter","title":"MailIntakeAdapter","text":"
Bases: ABC
Base adapter interface for mail providers.
Notes
Guarantees:
- Discover messages matching a query.\n- Retrieve full message payloads.\n- Retrieve full thread payloads.\nLifecycle:
- Adapters are intentionally read-only and must not mutate provider state.\n"},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter-functions","title":"Functions","text":""},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_message","title":"fetch_message
abstractmethod","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full raw message by message identifier.
Parameters:
Name Type Description Default
message_id str Provider-specific message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native message payload (e.g., Gmail message JSON structure).
"},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_thread","title":"fetch_thread
abstractmethod","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full raw thread by thread identifier.
Parameters:
Name Type Description Default
thread_id str Provider-specific thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native thread payload.
"},{"location":"mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs
abstractmethod","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over lightweight message references matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[dict[str, str]] Iterator[dict[str, str]]: An iterator over lightweight message reference dictionaries.
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message and thread identifiers.
Notes
Guarantees:
- Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n Example
Typical yield:
{\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n}\n"},{"location":"mail_intake/adapters/gmail/","title":"Gmail","text":""},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail","title":"mail_intake.adapters.gmail","text":""},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail--summary","title":"Summary","text":"
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. All Gmail-specific behavior must be strictly contained within this module.
"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail-classes","title":"Classes","text":""},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"
MailIntakeGmailAdapter(\n auth_provider: MailIntakeAuthProvider[Any],\n user_id: str = \"me\",\n)\n Bases: MailIntakeAdapter
Gmail read-only adapter.
This adapter implements the MailIntakeAdapter interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.
Notes
Responsibilities:
- This class is the ONLY place where `googleapiclient` is imported.\n- Gmail REST semantics are known.\n- `.execute()` is called.\nConstraints:
- Must remain thin and imperative.\n- Must not perform parsing or interpretation.\n- Must not expose Gmail-specific types beyond this class.\nInitialize the Gmail adapter.
Parameters:
Name Type Description Default
auth_provider MailIntakeAuthProvider Authentication provider capable of supplying valid Gmail API credentials.
required
user_id str Gmail user identifier. Defaults to \"me\".
'me'"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter-attributes","title":"Attributes","text":""},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.service","title":"service
property","text":"
service: Any\nLazily initialize and return the Gmail API service client.
Raises:
Type Description
MailIntakeAdapterError If the Gmail service cannot be initialized.
"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter-functions","title":"Functions","text":""},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full Gmail message by message ID.
Parameters:
Name Type Description Default
message_id str Gmail message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail message payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full Gmail thread by thread ID.
Parameters:
Name Type Description Default
thread_id str Gmail thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail thread payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"mail_intake/adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over message references matching the query.
Parameters:
Name Type Description Default
query str Gmail search query string.
required
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message_id and thread_id.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"mail_intake/auth/","title":"Auth","text":"
"},{"location":"mail_intake/auth/#mail_intake.auth","title":"mail_intake.auth","text":""},{"location":"mail_intake/auth/#mail_intake.auth--summary","title":"Summary","text":"
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. 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. Consumers should depend on the abstract interface and use concrete implementations only where explicitly required.
"},{"location":"mail_intake/auth/#mail_intake.auth--public-api","title":"Public API","text":"
MailIntakeAuthProviderMailIntakeGoogleAuth "},{"location":"mail_intake/auth/#mail_intake.auth-classes","title":"Classes","text":""},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"
Bases: ABC, Generic[T]
Abstract base class for authentication providers.
This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.
Notes
Responsibilities:
- 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.\nConstraints:
- 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.\n"},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeAuthProvider-functions","title":"Functions","text":""},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeAuthProvider.get_credentials","title":"get_credentials
abstractmethod","text":"
get_credentials() -> T\nRetrieve valid, provider-specific credentials.
Returns:
Name Type Description
T T Credentials of type T suitable for immediate use by the corresponding mail adapter.
Raises:
Type Description
Exception An authentication-specific exception indicating that credentials could not be obtained or validated.
Notes
Guarantees:
- 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.\n"},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"
MailIntakeGoogleAuth(\n credentials_path: str,\n store: CredentialStore[Any],\n scopes: Sequence[str],\n)\n Bases: MailIntakeAuthProvider
Google OAuth provider for Gmail access.
This provider implements the MailIntakeAuthProvider interface using Google's OAuth 2.0 flow and credential management libraries.
Notes
Responsibilities:
- 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.\nGuarantees:
- This class is synchronous by design and maintains a minimal\n internal state.\nInitialize the Google authentication provider.
Parameters:
Name Type Description Default
credentials_path str Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
required
store CredentialStore[Credentials] Credential store responsible for persisting and retrieving Google OAuth credentials.
required
scopes Sequence[str] OAuth scopes required for Gmail access.
required"},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeGoogleAuth-functions","title":"Functions","text":""},{"location":"mail_intake/auth/#mail_intake.auth.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"
get_credentials() -> Any\nRetrieve valid Google OAuth credentials.
Returns:
Name Type Description
Credentials Any A google.oauth2.credentials.Credentials instance suitable for use with Google API clients.
Raises:
Type Description
MailIntakeAuthError If credentials cannot be loaded, refreshed, or obtained via interactive authentication.
Notes
Lifecycle:
- 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.\n"},{"location":"mail_intake/auth/base/","title":"Base","text":""},{"location":"mail_intake/auth/base/#mail_intake.auth.base","title":"mail_intake.auth.base","text":""},{"location":"mail_intake/auth/base/#mail_intake.auth.base--summary","title":"Summary","text":"
Authentication provider contracts for Mail Intake.
This module defines the authentication abstraction layer used by mail adapters to obtain provider-specific credentials.
Authentication concerns are intentionally decoupled from adapter logic. Adapters depend only on this interface and must not be aware of how credentials are acquired, refreshed, or persisted.
"},{"location":"mail_intake/auth/base/#mail_intake.auth.base-classes","title":"Classes","text":""},{"location":"mail_intake/auth/base/#mail_intake.auth.base.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"
Bases: ABC, Generic[T]
Abstract base class for authentication providers.
This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.
Notes
Responsibilities:
- 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.\nConstraints:
- 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.\n"},{"location":"mail_intake/auth/base/#mail_intake.auth.base.MailIntakeAuthProvider-functions","title":"Functions","text":""},{"location":"mail_intake/auth/base/#mail_intake.auth.base.MailIntakeAuthProvider.get_credentials","title":"get_credentials
abstractmethod","text":"
get_credentials() -> T\nRetrieve valid, provider-specific credentials.
Returns:
Name Type Description
T T Credentials of type T suitable for immediate use by the corresponding mail adapter.
Raises:
Type Description
Exception An authentication-specific exception indicating that credentials could not be obtained or validated.
Notes
Guarantees:
- 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.\n"},{"location":"mail_intake/auth/google/","title":"Google","text":""},{"location":"mail_intake/auth/google/#mail_intake.auth.google","title":"mail_intake.auth.google","text":""},{"location":"mail_intake/auth/google/#mail_intake.auth.google--summary","title":"Summary","text":"
Google authentication provider implementation for Mail Intake.
This module provides a Google OAuth\u2013based 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. No Google authentication details should leak outside this module.
"},{"location":"mail_intake/auth/google/#mail_intake.auth.google-classes","title":"Classes","text":""},{"location":"mail_intake/auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"
MailIntakeGoogleAuth(\n credentials_path: str,\n store: CredentialStore[Any],\n scopes: Sequence[str],\n)\n Bases: MailIntakeAuthProvider
Google OAuth provider for Gmail access.
This provider implements the MailIntakeAuthProvider interface using Google's OAuth 2.0 flow and credential management libraries.
Notes
Responsibilities:
- 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.\nGuarantees:
- This class is synchronous by design and maintains a minimal\n internal state.\nInitialize the Google authentication provider.
Parameters:
Name Type Description Default
credentials_path str Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
required
store CredentialStore[Credentials] Credential store responsible for persisting and retrieving Google OAuth credentials.
required
scopes Sequence[str] OAuth scopes required for Gmail access.
required"},{"location":"mail_intake/auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth-functions","title":"Functions","text":""},{"location":"mail_intake/auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"
get_credentials() -> Any\nRetrieve valid Google OAuth credentials.
Returns:
Name Type Description
Credentials Any A google.oauth2.credentials.Credentials instance suitable for use with Google API clients.
Raises:
Type Description
MailIntakeAuthError If credentials cannot be loaded, refreshed, or obtained via interactive authentication.
Notes
Lifecycle:
- 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.\n"},{"location":"mail_intake/credentials/","title":"Credentials","text":"
"},{"location":"mail_intake/credentials/#mail_intake.credentials","title":"mail_intake.credentials","text":""},{"location":"mail_intake/credentials/#mail_intake.credentials--summary","title":"Summary","text":"
Credential persistence interfaces and implementations for Mail Intake.
This package defines the abstractions and concrete implementations used to persist authentication credentials across Mail Intake components.
The credential persistence layer is intentionally decoupled from authentication logic. Authentication providers are responsible for 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\u2013based 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.
"},{"location":"mail_intake/credentials/#mail_intake.credentials--public-api","title":"Public API","text":"
CredentialStorePickleCredentialStoreRedisCredentialStore "},{"location":"mail_intake/credentials/#mail_intake.credentials-classes","title":"Classes","text":""},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore","title":"CredentialStore","text":"
Bases: ABC, Generic[T]
Abstract base class defining a generic persistence interface.
Used for authentication credentials across different backends.
Notes
Responsibilities:
- Provide persistent storage separating life-cycle management from\n storage mechanics.\n- Keep implementation focused only on persistence.\nConstraints:
- 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.\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore-functions","title":"Functions","text":""},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore.clear","title":"clear
abstractmethod","text":"
clear() -> None\nRemove any persisted credentials from the store.
Notes
Lifecycle:
- 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\nGuarantees:
- Implementations should treat this operation as idempotent\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore.load","title":"load
abstractmethod","text":"
load() -> T | None\nLoad previously persisted credentials.
Returns:
Type Description
T | 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\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.\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.CredentialStore.save","title":"save
abstractmethod","text":"
save(credentials: T) -> None\nPersist credentials to the underlying storage backend.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required 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\nResponsibilities:
- Ensuring durability appropriate to the deployment context\n- Applying encryption or access controls where required\n- Overwriting any previously stored credentials\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore","title":"PickleCredentialStore","text":"
PickleCredentialStore(path: str)\n Bases: CredentialStore[T]
Filesystem-backed credential store using pickle serialization.
This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.
Notes
Guarantees:
- Stores credentials on the local filesystem.\n- Uses `pickle` for serialization and deserialization.\n- Does not provide encryption, locking, or concurrency guarantees.\nConstraints:
- Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.\nInitialize a pickle-backed credential store.
Parameters:
Name Type Description Default
path str Filesystem path where credentials will be stored. The file will be created or overwritten as needed.
required"},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore-functions","title":"Functions","text":""},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove persisted credentials from the local filesystem.
Notes
Lifecycle:
- This method deletes the credential file if it exists and should be treated as an idempotent operation\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from the local filesystem.
Returns:
Type Description
T | 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\n deserialized, this method returns `None`.\n- The store does not attempt to validate or interpret the\n returned credentials.\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.PickleCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to the local filesystem.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- Any previously stored credentials at the configured path are overwritten\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore","title":"RedisCredentialStore","text":"
RedisCredentialStore(\n redis_client: Any,\n key: str,\n serialize: Callable[[T], bytes],\n deserialize: Callable[[bytes], T],\n ttl_seconds: int | None = None,\n)\n Bases: CredentialStore[T]
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.
Notes
Responsibilities:
- 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.\nGuarantees:
- 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.\nInitialize a Redis-backed credential store.
Parameters:
Name Type Description Default
redis_client Any Initialized Redis client instance used for persistence.
required
key str Storage key under which credentials are persisted.
required
serialize Callable[[T], bytes] Callable that encodes credentials to bytes for storage.
required
deserialize Callable[[bytes], T] Callable that decodes stored bytes back into credentials.
required
ttl_seconds int | None Optional time-to-live in seconds after which stored credentials expire automatically. None disables expiry.
None"},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore-functions","title":"Functions","text":""},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove stored credentials from Redis.
Notes
Lifecycle:
- This operation deletes the configured Redis key if it exists\n- Implementations should treat this method as idempotent\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from Redis.
Returns:
Type Description
T | 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\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.\n"},{"location":"mail_intake/credentials/#mail_intake.credentials.RedisCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to Redis.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- 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\n"},{"location":"mail_intake/credentials/pickle/","title":"Pickle","text":""},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle","title":"mail_intake.credentials.pickle","text":""},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle--summary","title":"Summary","text":"
Local filesystem\u2013based credential persistence for Mail Intake.
This module provides a file-backed implementation of the CredentialStore abstraction using Python's pickle module.
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 serialization, this implementation is not suitable for distributed or untrusted environments.
"},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle-classes","title":"Classes","text":""},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore","title":"PickleCredentialStore","text":"
PickleCredentialStore(path: str)\n Bases: CredentialStore[T]
Filesystem-backed credential store using pickle serialization.
This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.
Notes
Guarantees:
- Stores credentials on the local filesystem.\n- Uses `pickle` for serialization and deserialization.\n- Does not provide encryption, locking, or concurrency guarantees.\nConstraints:
- Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.\nInitialize a pickle-backed credential store.
Parameters:
Name Type Description Default
path str Filesystem path where credentials will be stored. The file will be created or overwritten as needed.
required"},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore-functions","title":"Functions","text":""},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove persisted credentials from the local filesystem.
Notes
Lifecycle:
- This method deletes the credential file if it exists and should be treated as an idempotent operation\n"},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from the local filesystem.
Returns:
Type Description
T | 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\n deserialized, this method returns `None`.\n- The store does not attempt to validate or interpret the\n returned credentials.\n"},{"location":"mail_intake/credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to the local filesystem.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- Any previously stored credentials at the configured path are overwritten\n"},{"location":"mail_intake/credentials/redis/","title":"Redis","text":""},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis","title":"mail_intake.credentials.redis","text":""},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis--summary","title":"Summary","text":"
Redis-backed credential persistence for Mail Intake.
This module provides a Redis-based implementation of the CredentialStore abstraction, enabling credential persistence across distributed and horizontally scaled deployments.
The Redis credential store is designed for environments where authentication credentials must be shared safely across multiple 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. This module is responsible solely for persistence concerns. Credential validation, refresh, rotation, and acquisition remain the responsibility of authentication provider implementations.
"},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis-classes","title":"Classes","text":""},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore","title":"RedisCredentialStore","text":"
RedisCredentialStore(\n redis_client: Any,\n key: str,\n serialize: Callable[[T], bytes],\n deserialize: Callable[[bytes], T],\n ttl_seconds: int | None = None,\n)\n Bases: CredentialStore[T]
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.
Notes
Responsibilities:
- 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.\nGuarantees:
- 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.\nInitialize a Redis-backed credential store.
Parameters:
Name Type Description Default
redis_client Any Initialized Redis client instance used for persistence.
required
key str Storage key under which credentials are persisted.
required
serialize Callable[[T], bytes] Callable that encodes credentials to bytes for storage.
required
deserialize Callable[[bytes], T] Callable that decodes stored bytes back into credentials.
required
ttl_seconds int | None Optional time-to-live in seconds after which stored credentials expire automatically. None disables expiry.
None"},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore-functions","title":"Functions","text":""},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove stored credentials from Redis.
Notes
Lifecycle:
- This operation deletes the configured Redis key if it exists\n- Implementations should treat this method as idempotent\n"},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from Redis.
Returns:
Type Description
T | 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\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.\n"},{"location":"mail_intake/credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to Redis.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- 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\n"},{"location":"mail_intake/credentials/store/","title":"Store","text":""},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store","title":"mail_intake.credentials.store","text":""},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store--summary","title":"Summary","text":"
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 between credential lifecycle management and credential storage. Authentication providers are responsible for acquiring, validating, refreshing, and revoking credentials, while concrete store implementations are responsible solely for persistence concerns.
By remaining agnostic to credential structure, serialization format, and storage backend, this module enables multiple persistence strategies\u2014such as local files, in-memory caches, distributed stores, or secrets managers\u2014without coupling authentication logic to any specific storage mechanism.
"},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store-classes","title":"Classes","text":""},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore","title":"CredentialStore","text":"
Bases: ABC, Generic[T]
Abstract base class defining a generic persistence interface.
Used for authentication credentials across different backends.
Notes
Responsibilities:
- Provide persistent storage separating life-cycle management from\n storage mechanics.\n- Keep implementation focused only on persistence.\nConstraints:
- 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.\n"},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore-functions","title":"Functions","text":""},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore.clear","title":"clear
abstractmethod","text":"
clear() -> None\nRemove any persisted credentials from the store.
Notes
Lifecycle:
- 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\nGuarantees:
- Implementations should treat this operation as idempotent\n"},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore.load","title":"load
abstractmethod","text":"
load() -> T | None\nLoad previously persisted credentials.
Returns:
Type Description
T | 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\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.\n"},{"location":"mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore.save","title":"save
abstractmethod","text":"
save(credentials: T) -> None\nPersist credentials to the underlying storage backend.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required 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\nResponsibilities:
- Ensuring durability appropriate to the deployment context\n- Applying encryption or access controls where required\n- Overwriting any previously stored credentials\n"},{"location":"mail_intake/ingestion/","title":"Ingestion","text":"
"},{"location":"mail_intake/ingestion/#mail_intake.ingestion","title":"mail_intake.ingestion","text":""},{"location":"mail_intake/ingestion/#mail_intake.ingestion--summary","title":"Summary","text":"
Mail ingestion orchestration for Mail Intake.
This package contains high-level ingestion components responsible for coordinating mail retrieval, parsing, normalization, and model construction.
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. Consumers are expected to construct a mail adapter and pass it to the ingestion layer to begin processing messages and threads.
"},{"location":"mail_intake/ingestion/#mail_intake.ingestion--public-api","title":"Public API","text":"
"},{"location":"mail_intake/ingestion/#mail_intake.ingestion-classes","title":"Classes","text":""},{"location":"mail_intake/ingestion/#mail_intake.ingestion.MailIntakeReader","title":"MailIntakeReader","text":"
MailIntakeReader(adapter: MailIntakeAdapter)\nHigh-level read-only ingestion interface.
Notes
Responsibilities:
- 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.\nConstraints:
- This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.\nInitialize the mail reader.
Parameters:
Name Type Description Default
adapter MailIntakeAdapter Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
required"},{"location":"mail_intake/ingestion/#mail_intake.ingestion.MailIntakeReader-functions","title":"Functions","text":""},{"location":"mail_intake/ingestion/#mail_intake.ingestion.MailIntakeReader.iter_messages","title":"iter_messages","text":"
iter_messages(query: str) -> Iterator[MailIntakeMessage]\nIterate over parsed messages matching a provider query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Yields:
Name Type Description
MailIntakeMessage MailIntakeMessage Fully parsed and normalized MailIntakeMessage instances.
Raises:
Type Description
MailIntakeParsingError If a message cannot be parsed.
"},{"location":"mail_intake/ingestion/#mail_intake.ingestion.MailIntakeReader.iter_threads","title":"iter_threads","text":"
iter_threads(query: str) -> Iterator[MailIntakeThread]\nIterate over threads constructed from messages matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[MailIntakeThread] Iterator[MailIntakeThread]: An iterator over MailIntakeThread instances.
Raises:
Type Description
`MailIntakeParsingError` If a message cannot be parsed.
Notes
Guarantees:
- Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages.\n"},{"location":"mail_intake/ingestion/reader/","title":"Reader","text":""},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader","title":"mail_intake.ingestion.reader","text":""},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader--summary","title":"Summary","text":"
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. No provider-specific logic or API semantics are permitted in this layer.
"},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader-classes","title":"Classes","text":""},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader","title":"MailIntakeReader","text":"
MailIntakeReader(adapter: MailIntakeAdapter)\nHigh-level read-only ingestion interface.
Notes
Responsibilities:
- 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.\nConstraints:
- This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.\nInitialize the mail reader.
Parameters:
Name Type Description Default
adapter MailIntakeAdapter Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
required"},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader-functions","title":"Functions","text":""},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_messages","title":"iter_messages","text":"
iter_messages(query: str) -> Iterator[MailIntakeMessage]\nIterate over parsed messages matching a provider query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Yields:
Name Type Description
MailIntakeMessage MailIntakeMessage Fully parsed and normalized MailIntakeMessage instances.
Raises:
Type Description
MailIntakeParsingError If a message cannot be parsed.
"},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_threads","title":"iter_threads","text":"
iter_threads(query: str) -> Iterator[MailIntakeThread]\nIterate over threads constructed from messages matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[MailIntakeThread] Iterator[MailIntakeThread]: An iterator over MailIntakeThread instances.
Raises:
Type Description
`MailIntakeParsingError` If a message cannot be parsed.
Notes
Guarantees:
- Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages.\n"},{"location":"mail_intake/ingestion/reader/#mail_intake.ingestion.reader-functions","title":"Functions","text":""},{"location":"mail_intake/models/","title":"Models","text":"
"},{"location":"mail_intake/models/#mail_intake.models","title":"mail_intake.models","text":""},{"location":"mail_intake/models/#mail_intake.models--summary","title":"Summary","text":"
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. These models form the core internal data contract of the library.
"},{"location":"mail_intake/models/#mail_intake.models--public-api","title":"Public API","text":"
MailIntakeMessageMailIntakeThread "},{"location":"mail_intake/models/#mail_intake.models-classes","title":"Classes","text":""},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage","title":"MailIntakeMessage
dataclass","text":"
MailIntakeMessage(\n message_id: str,\n thread_id: str,\n timestamp: datetime,\n from_email: str,\n from_name: str | None,\n subject: str,\n body_text: str,\n snippet: str,\n raw_headers: dict[str, str],\n)\nCanonical internal representation of a single email message.
Notes
Guarantees:
- 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.\nConstraints:
- No provider-specific identifiers, payloads, or API semantics\n should appear in this model.\n"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage-attributes","title":"Attributes","text":""},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.body_text","title":"body_text
instance-attribute","text":"
body_text: str\nExtracted plain-text body content of the message.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.from_email","title":"from_email
instance-attribute","text":"
from_email: str\nSender email address.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.from_name","title":"from_name
instance-attribute","text":"
from_name: str | None\nOptional human-readable sender name.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.message_id","title":"message_id
instance-attribute","text":"
message_id: str\nProvider-specific message identifier.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.raw_headers","title":"raw_headers
instance-attribute","text":"
raw_headers: dict[str, str]\nNormalized mapping of message headers (header name \u2192 value).
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.snippet","title":"snippet
instance-attribute","text":"
snippet: str\nShort provider-supplied preview snippet of the message.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.subject","title":"subject
instance-attribute","text":"
subject: str\nRaw subject line of the message.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier to which this message belongs.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeMessage.timestamp","title":"timestamp
instance-attribute","text":"
timestamp: datetime\nMessage timestamp as a timezone-naive UTC datetime.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread","title":"MailIntakeThread
dataclass","text":"
MailIntakeThread(\n thread_id: str,\n normalized_subject: str,\n participants: set[str] = ...,\n messages: list[MailIntakeMessage] = ...,\n last_activity_at: datetime | None = ...,\n)\nCanonical internal representation of an email thread.
Notes
Guarantees:
- 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.\n"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread-attributes","title":"Attributes","text":""},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.last_activity_at","title":"last_activity_at
class-attribute instance-attribute","text":"
last_activity_at: datetime | None = None\nTimestamp of the most recent message in the thread.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.messages","title":"messages
class-attribute instance-attribute","text":"
messages: list[MailIntakeMessage] = field(\n default_factory=list\n)\nOrdered list of messages belonging to this thread.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.normalized_subject","title":"normalized_subject
instance-attribute","text":"
normalized_subject: str\nNormalized subject line used to group related messages.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.participants","title":"participants
class-attribute instance-attribute","text":"
participants: set[str] = field(default_factory=set)\nSet of unique participant email addresses observed in the thread.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier.
"},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread-functions","title":"Functions","text":""},{"location":"mail_intake/models/#mail_intake.models.MailIntakeThread.add_message","title":"add_message","text":"
add_message(message: MailIntakeMessage) -> None\nAdd a message to the thread and update derived fields.
Parameters:
Name Type Description Default
message MailIntakeMessage Parsed mail message to add to the thread.
required Notes
Responsibilities:
- Appends the message to the thread.\n- Tracks unique participants.\n- Updates the last activity timestamp.\n"},{"location":"mail_intake/models/message/","title":"Message","text":""},{"location":"mail_intake/models/message/#mail_intake.models.message","title":"mail_intake.models.message","text":""},{"location":"mail_intake/models/message/#mail_intake.models.message--summary","title":"Summary","text":"
Message domain models for Mail Intake.
This module defines the canonical, provider-agnostic representation of an individual email message as used internally by the Mail Intake ingestion pipeline.
Models in this module are safe to persist and must not contain any provider-specific fields or semantics.
"},{"location":"mail_intake/models/message/#mail_intake.models.message-classes","title":"Classes","text":""},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage","title":"MailIntakeMessage
dataclass","text":"
MailIntakeMessage(\n message_id: str,\n thread_id: str,\n timestamp: datetime,\n from_email: str,\n from_name: str | None,\n subject: str,\n body_text: str,\n snippet: str,\n raw_headers: dict[str, str],\n)\nCanonical internal representation of a single email message.
Notes
Guarantees:
- 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.\nConstraints:
- No provider-specific identifiers, payloads, or API semantics\n should appear in this model.\n"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage-attributes","title":"Attributes","text":""},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.body_text","title":"body_text
instance-attribute","text":"
body_text: str\nExtracted plain-text body content of the message.
"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.from_email","title":"from_email
instance-attribute","text":"
from_email: str\nSender email address.
"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.from_name","title":"from_name
instance-attribute","text":"
from_name: str | None\nOptional human-readable sender name.
"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.message_id","title":"message_id
instance-attribute","text":"
message_id: str\nProvider-specific message identifier.
"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.raw_headers","title":"raw_headers
instance-attribute","text":"
raw_headers: dict[str, str]\nNormalized mapping of message headers (header name \u2192 value).
"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.snippet","title":"snippet
instance-attribute","text":"
snippet: str\nShort provider-supplied preview snippet of the message.
"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.subject","title":"subject
instance-attribute","text":"
subject: str\nRaw subject line of the message.
"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier to which this message belongs.
"},{"location":"mail_intake/models/message/#mail_intake.models.message.MailIntakeMessage.timestamp","title":"timestamp
instance-attribute","text":"
timestamp: datetime\nMessage timestamp as a timezone-naive UTC datetime.
"},{"location":"mail_intake/models/thread/","title":"Thread","text":""},{"location":"mail_intake/models/thread/#mail_intake.models.thread","title":"mail_intake.models.thread","text":""},{"location":"mail_intake/models/thread/#mail_intake.models.thread--summary","title":"Summary","text":"
Thread domain models for Mail Intake.
This module defines the canonical, provider-agnostic representation of an email thread as used internally by the Mail Intake ingestion pipeline.
Threads group related messages and serve as the primary unit of reasoning for higher-level correspondence workflows.
"},{"location":"mail_intake/models/thread/#mail_intake.models.thread-classes","title":"Classes","text":""},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread","title":"MailIntakeThread
dataclass","text":"
MailIntakeThread(\n thread_id: str,\n normalized_subject: str,\n participants: set[str] = ...,\n messages: list[MailIntakeMessage] = ...,\n last_activity_at: datetime | None = ...,\n)\nCanonical internal representation of an email thread.
Notes
Guarantees:
- 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.\n"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread-attributes","title":"Attributes","text":""},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.last_activity_at","title":"last_activity_at
class-attribute instance-attribute","text":"
last_activity_at: datetime | None = None\nTimestamp of the most recent message in the thread.
"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.messages","title":"messages
class-attribute instance-attribute","text":"
messages: list[MailIntakeMessage] = field(\n default_factory=list\n)\nOrdered list of messages belonging to this thread.
"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.normalized_subject","title":"normalized_subject
instance-attribute","text":"
normalized_subject: str\nNormalized subject line used to group related messages.
"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.participants","title":"participants
class-attribute instance-attribute","text":"
participants: set[str] = field(default_factory=set)\nSet of unique participant email addresses observed in the thread.
"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier.
"},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread-functions","title":"Functions","text":""},{"location":"mail_intake/models/thread/#mail_intake.models.thread.MailIntakeThread.add_message","title":"add_message","text":"
add_message(message: MailIntakeMessage) -> None\nAdd a message to the thread and update derived fields.
Parameters:
Name Type Description Default
message MailIntakeMessage Parsed mail message to add to the thread.
required Notes
Responsibilities:
- Appends the message to the thread.\n- Tracks unique participants.\n- Updates the last activity timestamp.\n"},{"location":"mail_intake/parsers/","title":"Parsers","text":"
"},{"location":"mail_intake/parsers/#mail_intake.parsers","title":"mail_intake.parsers","text":""},{"location":"mail_intake/parsers/#mail_intake.parsers--summary","title":"Summary","text":"
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. This package does not:
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.
"},{"location":"mail_intake/parsers/#mail_intake.parsers--public-api","title":"Public API","text":"
extract_bodyparse_headersextract_sendernormalize_subject "},{"location":"mail_intake/parsers/#mail_intake.parsers-functions","title":"Functions","text":""},{"location":"mail_intake/parsers/#mail_intake.parsers.extract_body","title":"extract_body","text":"
extract_body(payload: dict[str, Any]) -> str\nExtract the best-effort message body from a Gmail payload.
Priority:
text/plaintext/html (stripped to text)Single-part body Empty string (if nothing usable found) Parameters:
Name Type Description Default
payload dict[str, Any] Provider-native message payload dictionary.
required
Returns:
Name Type Description
str str Extracted plain-text message body.
"},{"location":"mail_intake/parsers/#mail_intake.parsers.extract_sender","title":"extract_sender","text":"
extract_sender(\n headers: dict[str, str],\n) -> tuple[str, str | None]\nExtract sender email and optional display name from headers.
Parameters:
Name Type Description Default
headers dict[str, str] Normalized header dictionary as returned by parse_headers().
required
Returns:
Type Description
tuple[str, str | None] tuple[str, str | None]: A tuple (email, name) where email is the sender email address and name is the display name, or None if unavailable.
Notes
Responsibilities:
- This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n Example
Typical values:
\"John Doe <john@example.com>\" -> (\"john@example.com\", \"John Doe\")\"john@example.com\" -> (\"john@example.com\", None) "},{"location":"mail_intake/parsers/#mail_intake.parsers.normalize_subject","title":"normalize_subject","text":"
normalize_subject(subject: str) -> str\nNormalize an email subject for thread-level comparison.
Parameters:
Name Type Description Default
subject str Raw subject line from a message header.
required
Returns:
Name Type Description
str str Normalized subject string suitable for thread grouping.
Notes
Responsibilities:
- 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).\nGuarantees:
- This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject.\n"},{"location":"mail_intake/parsers/#mail_intake.parsers.parse_headers","title":"parse_headers","text":"
parse_headers(\n raw_headers: list[dict[str, str]],\n) -> dict[str, str]\nConvert a list of Gmail-style headers into a normalized dict.
Parameters:
Name Type Description Default
raw_headers list[dict[str, str]] List of header dictionaries, each containing name and value keys.
required
Returns:
Type Description
dict[str, str] dict[str, str]: Dictionary mapping lowercase header names to stripped values.
Notes
Guarantees:
- 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 Example
Typical usage:
Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\nOutput:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n"},{"location":"mail_intake/parsers/body/","title":"Body","text":""},{"location":"mail_intake/parsers/body/#mail_intake.parsers.body","title":"mail_intake.parsers.body","text":""},{"location":"mail_intake/parsers/body/#mail_intake.parsers.body--summary","title":"Summary","text":"
Message body extraction utilities for Mail Intake.
This module contains helper functions for extracting a best-effort plain-text body from provider-native message payloads.
The logic is intentionally tolerant of malformed or partial data and prefers human-readable text over fidelity to original formatting.
"},{"location":"mail_intake/parsers/body/#mail_intake.parsers.body-classes","title":"Classes","text":""},{"location":"mail_intake/parsers/body/#mail_intake.parsers.body-functions","title":"Functions","text":""},{"location":"mail_intake/parsers/body/#mail_intake.parsers.body.extract_body","title":"extract_body","text":"
extract_body(payload: dict[str, Any]) -> str\nExtract the best-effort message body from a Gmail payload.
Priority:
text/plaintext/html (stripped to text)Single-part body Empty string (if nothing usable found) Parameters:
Name Type Description Default
payload dict[str, Any] Provider-native message payload dictionary.
required
Returns:
Name Type Description
str str Extracted plain-text message body.
"},{"location":"mail_intake/parsers/headers/","title":"Headers","text":""},{"location":"mail_intake/parsers/headers/#mail_intake.parsers.headers","title":"mail_intake.parsers.headers","text":""},{"location":"mail_intake/parsers/headers/#mail_intake.parsers.headers--summary","title":"Summary","text":"
Message header parsing utilities for Mail Intake.
This module provides helper functions for normalizing and extracting useful information from provider-native message headers.
The functions here are intentionally simple and tolerant of malformed or incomplete header data.
"},{"location":"mail_intake/parsers/headers/#mail_intake.parsers.headers-functions","title":"Functions","text":""},{"location":"mail_intake/parsers/headers/#mail_intake.parsers.headers.extract_sender","title":"extract_sender","text":"
extract_sender(\n headers: dict[str, str],\n) -> tuple[str, str | None]\nExtract sender email and optional display name from headers.
Parameters:
Name Type Description Default
headers dict[str, str] Normalized header dictionary as returned by parse_headers().
required
Returns:
Type Description
tuple[str, str | None] tuple[str, str | None]: A tuple (email, name) where email is the sender email address and name is the display name, or None if unavailable.
Notes
Responsibilities:
- This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n Example
Typical values:
\"John Doe <john@example.com>\" -> (\"john@example.com\", \"John Doe\")\"john@example.com\" -> (\"john@example.com\", None) "},{"location":"mail_intake/parsers/headers/#mail_intake.parsers.headers.parse_headers","title":"parse_headers","text":"
parse_headers(\n raw_headers: list[dict[str, str]],\n) -> dict[str, str]\nConvert a list of Gmail-style headers into a normalized dict.
Parameters:
Name Type Description Default
raw_headers list[dict[str, str]] List of header dictionaries, each containing name and value keys.
required
Returns:
Type Description
dict[str, str] dict[str, str]: Dictionary mapping lowercase header names to stripped values.
Notes
Guarantees:
- 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 Example
Typical usage:
Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\nOutput:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n"},{"location":"mail_intake/parsers/subject/","title":"Subject","text":""},{"location":"mail_intake/parsers/subject/#mail_intake.parsers.subject","title":"mail_intake.parsers.subject","text":""},{"location":"mail_intake/parsers/subject/#mail_intake.parsers.subject--summary","title":"Summary","text":"
Subject line normalization utilities for Mail Intake.
This module provides helper functions for normalizing email subject lines to enable reliable thread-level comparison and grouping.
Normalization is intentionally conservative to avoid altering semantic meaning while removing common reply and forward prefixes.
"},{"location":"mail_intake/parsers/subject/#mail_intake.parsers.subject-functions","title":"Functions","text":""},{"location":"mail_intake/parsers/subject/#mail_intake.parsers.subject.normalize_subject","title":"normalize_subject","text":"
normalize_subject(subject: str) -> str\nNormalize an email subject for thread-level comparison.
Parameters:
Name Type Description Default
subject str Raw subject line from a message header.
required
Returns:
Name Type Description
str str Normalized subject string suitable for thread grouping.
Notes
Responsibilities:
- 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).\nGuarantees:
- This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject.\n"},{"location":"models/","title":"Models","text":""},{"location":"models/#mail_intake.models","title":"mail_intake.models","text":""},{"location":"models/#mail_intake.models--summary","title":"Summary","text":"
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. These models form the core internal data contract of the library.
"},{"location":"models/#mail_intake.models--public-api","title":"Public API","text":"
MailIntakeMessageMailIntakeThread "},{"location":"models/#mail_intake.models-classes","title":"Classes","text":""},{"location":"models/#mail_intake.models.MailIntakeMessage","title":"MailIntakeMessage
dataclass","text":"
MailIntakeMessage(\n message_id: str,\n thread_id: str,\n timestamp: datetime,\n from_email: str,\n from_name: str | None,\n subject: str,\n body_text: str,\n snippet: str,\n raw_headers: dict[str, str],\n)\nCanonical internal representation of a single email message.
Notes
Guarantees:
- 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.\nConstraints:
- No provider-specific identifiers, payloads, or API semantics\n should appear in this model.\n"},{"location":"models/#mail_intake.models.MailIntakeMessage-attributes","title":"Attributes","text":""},{"location":"models/#mail_intake.models.MailIntakeMessage.body_text","title":"body_text
instance-attribute","text":"
body_text: str\nExtracted plain-text body content of the message.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.from_email","title":"from_email
instance-attribute","text":"
from_email: str\nSender email address.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.from_name","title":"from_name
instance-attribute","text":"
from_name: str | None\nOptional human-readable sender name.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.message_id","title":"message_id
instance-attribute","text":"
message_id: str\nProvider-specific message identifier.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.raw_headers","title":"raw_headers
instance-attribute","text":"
raw_headers: dict[str, str]\nNormalized mapping of message headers (header name \u2192 value).
"},{"location":"models/#mail_intake.models.MailIntakeMessage.snippet","title":"snippet
instance-attribute","text":"
snippet: str\nShort provider-supplied preview snippet of the message.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.subject","title":"subject
instance-attribute","text":"
subject: str\nRaw subject line of the message.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier to which this message belongs.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.timestamp","title":"timestamp
instance-attribute","text":"
timestamp: datetime\nMessage timestamp as a timezone-naive UTC datetime.
"},{"location":"models/#mail_intake.models.MailIntakeThread","title":"MailIntakeThread
dataclass","text":"
MailIntakeThread(\n thread_id: str,\n normalized_subject: str,\n participants: set[str] = ...,\n messages: list[MailIntakeMessage] = ...,\n last_activity_at: datetime | None = ...,\n)\nCanonical internal representation of an email thread.
Notes
Guarantees:
- 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.\n"},{"location":"models/#mail_intake.models.MailIntakeThread-attributes","title":"Attributes","text":""},{"location":"models/#mail_intake.models.MailIntakeThread.last_activity_at","title":"last_activity_at
class-attribute instance-attribute","text":"
last_activity_at: datetime | None = None\nTimestamp of the most recent message in the thread.
"},{"location":"models/#mail_intake.models.MailIntakeThread.messages","title":"messages
class-attribute instance-attribute","text":"
messages: list[MailIntakeMessage] = field(\n default_factory=list\n)\nOrdered list of messages belonging to this thread.
"},{"location":"models/#mail_intake.models.MailIntakeThread.normalized_subject","title":"normalized_subject
instance-attribute","text":"
normalized_subject: str\nNormalized subject line used to group related messages.
"},{"location":"models/#mail_intake.models.MailIntakeThread.participants","title":"participants
class-attribute instance-attribute","text":"
participants: set[str] = field(default_factory=set)\nSet of unique participant email addresses observed in the thread.
"},{"location":"models/#mail_intake.models.MailIntakeThread.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier.
"},{"location":"models/#mail_intake.models.MailIntakeThread-functions","title":"Functions","text":""},{"location":"models/#mail_intake.models.MailIntakeThread.add_message","title":"add_message","text":"
add_message(message: MailIntakeMessage) -> None\nAdd a message to the thread and update derived fields.
Parameters:
Name Type Description Default
message MailIntakeMessage Parsed mail message to add to the thread.
required Notes
Responsibilities:
- Appends the message to the thread.\n- Tracks unique participants.\n- Updates the last activity timestamp.\n"},{"location":"models/message/","title":"Message","text":""},{"location":"models/message/#mail_intake.models.message","title":"mail_intake.models.message","text":""},{"location":"models/message/#mail_intake.models.message--summary","title":"Summary","text":"
Message domain models for Mail Intake.
This module defines the canonical, provider-agnostic representation of an individual email message as used internally by the Mail Intake ingestion pipeline.
Models in this module are safe to persist and must not contain any provider-specific fields or semantics.
"},{"location":"models/message/#mail_intake.models.message-classes","title":"Classes","text":""},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage","title":"MailIntakeMessage
dataclass","text":"
MailIntakeMessage(\n message_id: str,\n thread_id: str,\n timestamp: datetime,\n from_email: str,\n from_name: str | None,\n subject: str,\n body_text: str,\n snippet: str,\n raw_headers: dict[str, str],\n)\nCanonical internal representation of a single email message.
Notes
Guarantees:
- 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.\nConstraints:
- No provider-specific identifiers, payloads, or API semantics\n should appear in this model.\n"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage-attributes","title":"Attributes","text":""},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.body_text","title":"body_text
instance-attribute","text":"
body_text: str\nExtracted plain-text body content of the message.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.from_email","title":"from_email
instance-attribute","text":"
from_email: str\nSender email address.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.from_name","title":"from_name
instance-attribute","text":"
from_name: str | None\nOptional human-readable sender name.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.message_id","title":"message_id
instance-attribute","text":"
message_id: str\nProvider-specific message identifier.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.raw_headers","title":"raw_headers
instance-attribute","text":"
raw_headers: dict[str, str]\nNormalized mapping of message headers (header name \u2192 value).
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.snippet","title":"snippet
instance-attribute","text":"
snippet: str\nShort provider-supplied preview snippet of the message.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.subject","title":"subject
instance-attribute","text":"
subject: str\nRaw subject line of the message.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier to which this message belongs.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.timestamp","title":"timestamp
instance-attribute","text":"
timestamp: datetime\nMessage timestamp as a timezone-naive UTC datetime.
"},{"location":"models/thread/","title":"Thread","text":""},{"location":"models/thread/#mail_intake.models.thread","title":"mail_intake.models.thread","text":""},{"location":"models/thread/#mail_intake.models.thread--summary","title":"Summary","text":"
Thread domain models for Mail Intake.
This module defines the canonical, provider-agnostic representation of an email thread as used internally by the Mail Intake ingestion pipeline.
Threads group related messages and serve as the primary unit of reasoning for higher-level correspondence workflows.
"},{"location":"models/thread/#mail_intake.models.thread-classes","title":"Classes","text":""},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread","title":"MailIntakeThread
dataclass","text":"
MailIntakeThread(\n thread_id: str,\n normalized_subject: str,\n participants: set[str] = ...,\n messages: list[MailIntakeMessage] = ...,\n last_activity_at: datetime | None = ...,\n)\nCanonical internal representation of an email thread.
Notes
Guarantees:
- 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.\n"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread-attributes","title":"Attributes","text":""},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.last_activity_at","title":"last_activity_at
class-attribute instance-attribute","text":"
last_activity_at: datetime | None = None\nTimestamp of the most recent message in the thread.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.messages","title":"messages
class-attribute instance-attribute","text":"
messages: list[MailIntakeMessage] = field(\n default_factory=list\n)\nOrdered list of messages belonging to this thread.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.normalized_subject","title":"normalized_subject
instance-attribute","text":"
normalized_subject: str\nNormalized subject line used to group related messages.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.participants","title":"participants
class-attribute instance-attribute","text":"
participants: set[str] = field(default_factory=set)\nSet of unique participant email addresses observed in the thread.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread-functions","title":"Functions","text":""},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.add_message","title":"add_message","text":"
add_message(message: MailIntakeMessage) -> None\nAdd a message to the thread and update derived fields.
Parameters:
Name Type Description Default
message MailIntakeMessage Parsed mail message to add to the thread.
required Notes
Responsibilities:
- Appends the message to the thread.\n- Tracks unique participants.\n- Updates the last activity timestamp.\n"},{"location":"parsers/","title":"Parsers","text":""},{"location":"parsers/#mail_intake.parsers","title":"mail_intake.parsers","text":""},{"location":"parsers/#mail_intake.parsers--summary","title":"Summary","text":"
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. This package does not:
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.
"},{"location":"parsers/#mail_intake.parsers--public-api","title":"Public API","text":"
extract_bodyparse_headersextract_sendernormalize_subject "},{"location":"parsers/#mail_intake.parsers-functions","title":"Functions","text":""},{"location":"parsers/#mail_intake.parsers.extract_body","title":"extract_body","text":"
extract_body(payload: dict[str, Any]) -> str\nExtract the best-effort message body from a Gmail payload.
Priority:
text/plaintext/html (stripped to text)Single-part body Empty string (if nothing usable found) Parameters:
Name Type Description Default
payload dict[str, Any] Provider-native message payload dictionary.
required
Returns:
Name Type Description
str str Extracted plain-text message body.
"},{"location":"parsers/#mail_intake.parsers.extract_sender","title":"extract_sender","text":"
extract_sender(\n headers: dict[str, str],\n) -> tuple[str, str | None]\nExtract sender email and optional display name from headers.
Parameters:
Name Type Description Default
headers dict[str, str] Normalized header dictionary as returned by parse_headers().
required
Returns:
Type Description
tuple[str, str | None] tuple[str, str | None]: A tuple (email, name) where email is the sender email address and name is the display name, or None if unavailable.
Notes
Responsibilities:
- This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n Example
Typical values:
\"John Doe <john@example.com>\" -> (\"john@example.com\", \"John Doe\")\"john@example.com\" -> (\"john@example.com\", None) "},{"location":"parsers/#mail_intake.parsers.normalize_subject","title":"normalize_subject","text":"
normalize_subject(subject: str) -> str\nNormalize an email subject for thread-level comparison.
Parameters:
Name Type Description Default
subject str Raw subject line from a message header.
required
Returns:
Name Type Description
str str Normalized subject string suitable for thread grouping.
Notes
Responsibilities:
- 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).\nGuarantees:
- This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject.\n"},{"location":"parsers/#mail_intake.parsers.parse_headers","title":"parse_headers","text":"
parse_headers(\n raw_headers: list[dict[str, str]],\n) -> dict[str, str]\nConvert a list of Gmail-style headers into a normalized dict.
Parameters:
Name Type Description Default
raw_headers list[dict[str, str]] List of header dictionaries, each containing name and value keys.
required
Returns:
Type Description
dict[str, str] dict[str, str]: Dictionary mapping lowercase header names to stripped values.
Notes
Guarantees:
- 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 Example
Typical usage:
Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\nOutput:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n"},{"location":"parsers/body/","title":"Body","text":""},{"location":"parsers/body/#mail_intake.parsers.body","title":"mail_intake.parsers.body","text":""},{"location":"parsers/body/#mail_intake.parsers.body--summary","title":"Summary","text":"
Message body extraction utilities for Mail Intake.
This module contains helper functions for extracting a best-effort plain-text body from provider-native message payloads.
The logic is intentionally tolerant of malformed or partial data and prefers human-readable text over fidelity to original formatting.
"},{"location":"parsers/body/#mail_intake.parsers.body-classes","title":"Classes","text":""},{"location":"parsers/body/#mail_intake.parsers.body-functions","title":"Functions","text":""},{"location":"parsers/body/#mail_intake.parsers.body.extract_body","title":"extract_body","text":"
extract_body(payload: dict[str, Any]) -> str\nExtract the best-effort message body from a Gmail payload.
Priority:
text/plaintext/html (stripped to text)Single-part body Empty string (if nothing usable found) Parameters:
Name Type Description Default
payload dict[str, Any] Provider-native message payload dictionary.
required
Returns:
Name Type Description
str str Extracted plain-text message body.
"},{"location":"parsers/headers/","title":"Headers","text":""},{"location":"parsers/headers/#mail_intake.parsers.headers","title":"mail_intake.parsers.headers","text":""},{"location":"parsers/headers/#mail_intake.parsers.headers--summary","title":"Summary","text":"
Message header parsing utilities for Mail Intake.
This module provides helper functions for normalizing and extracting useful information from provider-native message headers.
The functions here are intentionally simple and tolerant of malformed or incomplete header data.
"},{"location":"parsers/headers/#mail_intake.parsers.headers-functions","title":"Functions","text":""},{"location":"parsers/headers/#mail_intake.parsers.headers.extract_sender","title":"extract_sender","text":"
extract_sender(\n headers: dict[str, str],\n) -> tuple[str, str | None]\nExtract sender email and optional display name from headers.
Parameters:
Name Type Description Default
headers dict[str, str] Normalized header dictionary as returned by parse_headers().
required
Returns:
Type Description
tuple[str, str | None] tuple[str, str | None]: A tuple (email, name) where email is the sender email address and name is the display name, or None if unavailable.
Notes
Responsibilities:
- This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n Example
Typical values:
\"John Doe <john@example.com>\" -> (\"john@example.com\", \"John Doe\")\"john@example.com\" -> (\"john@example.com\", None) "},{"location":"parsers/headers/#mail_intake.parsers.headers.parse_headers","title":"parse_headers","text":"
parse_headers(\n raw_headers: list[dict[str, str]],\n) -> dict[str, str]\nConvert a list of Gmail-style headers into a normalized dict.
Parameters:
Name Type Description Default
raw_headers list[dict[str, str]] List of header dictionaries, each containing name and value keys.
required
Returns:
Type Description
dict[str, str] dict[str, str]: Dictionary mapping lowercase header names to stripped values.
Notes
Guarantees:
- 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 Example
Typical usage:
Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\nOutput:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n"},{"location":"parsers/subject/","title":"Subject","text":""},{"location":"parsers/subject/#mail_intake.parsers.subject","title":"mail_intake.parsers.subject","text":""},{"location":"parsers/subject/#mail_intake.parsers.subject--summary","title":"Summary","text":"
Subject line normalization utilities for Mail Intake.
This module provides helper functions for normalizing email subject lines to enable reliable thread-level comparison and grouping.
Normalization is intentionally conservative to avoid altering semantic meaning while removing common reply and forward prefixes.
"},{"location":"parsers/subject/#mail_intake.parsers.subject-functions","title":"Functions","text":""},{"location":"parsers/subject/#mail_intake.parsers.subject.normalize_subject","title":"normalize_subject","text":"
normalize_subject(subject: str) -> str\nNormalize an email subject for thread-level comparison.
Parameters:
Name Type Description Default
subject str Raw subject line from a message header.
required
Returns:
Name Type Description
str str Normalized subject string suitable for thread grouping.
Notes
Responsibilities:
- 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).\nGuarantees:
- This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject.\n"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"mail_intake","text":""},{"location":"#mail_intake","title":"mail_intake","text":""},{"location":"#mail_intake--summary","title":"Summary","text":"
Mail Intake \u2014 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.
"},{"location":"#mail_intake--installation","title":"Installation","text":"
Install using pip:
pip install mail-intake\nOr with Poetry:
poetry add mail-intake\nMail Intake is pure Python and has no runtime dependencies beyond those required by the selected provider (for example, Google APIs for Gmail).
"},{"location":"#mail_intake--quick-start","title":"Quick Start","text":"
Minimal Gmail ingestion example (local development):
from mail_intake.ingestion import MailIntakeReader\nfrom mail_intake.adapters import MailIntakeGmailAdapter\nfrom mail_intake.auth import MailIntakeGoogleAuth\nfrom mail_intake.credentials import PickleCredentialStore\n\nstore = PickleCredentialStore(path=\"token.pickle\")\n\nauth = MailIntakeGoogleAuth(\n credentials_path=\"credentials.json\",\n store=store,\n scopes=[\"https://www.googleapis.com/auth/gmail.readonly\"],\n)\n\nadapter = MailIntakeGmailAdapter(auth_provider=auth)\nreader = MailIntakeReader(adapter)\n\nfor message in reader.iter_messages(\"from:recruiter@example.com\"):\n print(message.subject, message.from_email)\nIterating over threads:
for thread in reader.iter_threads(\"subject:Interview\"):\n print(thread.normalized_subject, len(thread.messages))\n"},{"location":"#mail_intake--architecture","title":"Architecture","text":"
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:
Layered Decoupling: Adapters handle transport, Parsers handle format normalization, and Ingestion orchestrates. Provider Agnosticism: Domain models and core logic never depend on provider-specific (e.g., Gmail) API internals. Stateless Workflows: The library functions as a read-only pipe, ensuring side-effect-free ingestion. "},{"location":"#mail_intake--public-api","title":"Public API","text":"
The supported public API consists of the following top-level modules:
mail_intake.ingestionmail_intake.adaptersmail_intake.authmail_intake.credentialsmail_intake.parsersmail_intake.modelsmail_intake.configmail_intake.exceptions Classes and functions should be imported explicitly from these modules. No individual symbols are re-exported at the package root.
"},{"location":"config/","title":"Config","text":""},{"location":"config/#mail_intake.config","title":"mail_intake.config","text":""},{"location":"config/#mail_intake.config--summary","title":"Summary","text":"
Global configuration models for Mail Intake.
This module defines the top-level configuration object used to control mail ingestion behavior across adapters, authentication providers, and ingestion workflows.
Configuration is intentionally explicit, immutable, and free of implicit environment reads to ensure predictability and testability.
"},{"location":"config/#mail_intake.config-classes","title":"Classes","text":""},{"location":"config/#mail_intake.config.MailIntakeConfig","title":"MailIntakeConfig
dataclass","text":"
MailIntakeConfig(\n provider: str = ...,\n user_id: str = ...,\n readonly: bool = ...,\n credentials_path: str | None = ...,\n token_path: str | None = ...,\n)\nGlobal configuration for mail-intake.
Notes
Guarantees:
- 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.\n"},{"location":"config/#mail_intake.config.MailIntakeConfig-attributes","title":"Attributes","text":""},{"location":"config/#mail_intake.config.MailIntakeConfig.credentials_path","title":"credentials_path
class-attribute instance-attribute","text":"
credentials_path: str | None = None\nOptional path to provider credentials configuration.
"},{"location":"config/#mail_intake.config.MailIntakeConfig.provider","title":"provider
class-attribute instance-attribute","text":"
provider: str = 'gmail'\nIdentifier of the mail provider to use (e.g., \"gmail\").
"},{"location":"config/#mail_intake.config.MailIntakeConfig.readonly","title":"readonly
class-attribute instance-attribute","text":"
readonly: bool = True\nWhether ingestion should operate in read-only mode.
"},{"location":"config/#mail_intake.config.MailIntakeConfig.token_path","title":"token_path
class-attribute instance-attribute","text":"
token_path: str | None = None\nOptional path to persisted authentication tokens.
"},{"location":"config/#mail_intake.config.MailIntakeConfig.user_id","title":"user_id
class-attribute instance-attribute","text":"
user_id: str = 'me'\nProvider-specific user identifier. Defaults to the authenticated user.
"},{"location":"exceptions/","title":"Exceptions","text":""},{"location":"exceptions/#mail_intake.exceptions","title":"mail_intake.exceptions","text":""},{"location":"exceptions/#mail_intake.exceptions--summary","title":"Summary","text":"
Exception hierarchy for Mail Intake.
This module defines the canonical exception types used throughout the Mail Intake library.
All library-raised errors derive from MailIntakeError. Consumers are encouraged to catch this base type (or specific subclasses) rather than provider-specific or third-party exceptions.
"},{"location":"exceptions/#mail_intake.exceptions-classes","title":"Classes","text":""},{"location":"exceptions/#mail_intake.exceptions.MailIntakeAdapterError","title":"MailIntakeAdapterError","text":"
Bases: MailIntakeError
Errors raised by mail provider adapters.
Notes
Lifecycle:
- Raised when a provider adapter encounters API errors, transport\n failures, or invalid provider responses.\n"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeAuthError","title":"MailIntakeAuthError","text":"
Bases: MailIntakeError
Authentication and credential-related failures.
Notes
Lifecycle:
- Raised when authentication providers are unable to acquire,\n refresh, or persist valid credentials.\n"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeError","title":"MailIntakeError","text":"
Bases: Exception
Base exception for all Mail Intake errors.
Notes
Guarantees:
- 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\n"},{"location":"exceptions/#mail_intake.exceptions.MailIntakeParsingError","title":"MailIntakeParsingError","text":"
Bases: MailIntakeError
Errors encountered while parsing message content.
Notes
Lifecycle:
- Raised when raw provider payloads cannot be interpreted or\n normalized into internal domain models.\n"},{"location":"adapters/","title":"Adapters","text":""},{"location":"adapters/#mail_intake.adapters","title":"mail_intake.adapters","text":""},{"location":"adapters/#mail_intake.adapters--summary","title":"Summary","text":"
Mail provider adapter implementations for Mail Intake.
This package contains adapter-layer implementations responsible for 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. Provider-specific logic must not leak outside of adapter implementations. All parsings, normalizations, and transformations must be handled by downstream components.
"},{"location":"adapters/#mail_intake.adapters--public-api","title":"Public API","text":"
MailIntakeAdapterMailIntakeGmailAdapter "},{"location":"adapters/#mail_intake.adapters-classes","title":"Classes","text":""},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter","title":"MailIntakeAdapter","text":"
Bases: ABC
Base adapter interface for mail providers.
Notes
Guarantees:
- Discover messages matching a query.\n- Retrieve full message payloads.\n- Retrieve full thread payloads.\nLifecycle:
- Adapters are intentionally read-only and must not mutate provider state.\n"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter-functions","title":"Functions","text":""},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_message","title":"fetch_message
abstractmethod","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full raw message by message identifier.
Parameters:
Name Type Description Default
message_id str Provider-specific message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native message payload (e.g., Gmail message JSON structure).
"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.fetch_thread","title":"fetch_thread
abstractmethod","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full raw thread by thread identifier.
Parameters:
Name Type Description Default
thread_id str Provider-specific thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native thread payload.
"},{"location":"adapters/#mail_intake.adapters.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs
abstractmethod","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over lightweight message references matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[dict[str, str]] Iterator[dict[str, str]]: An iterator over lightweight message reference dictionaries.
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message and thread identifiers.
Notes
Guarantees:
- Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n Example
Typical yield:
{\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n}\n"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"
MailIntakeGmailAdapter(\n auth_provider: MailIntakeAuthProvider[Any],\n user_id: str = \"me\",\n)\n Bases: MailIntakeAdapter
Gmail read-only adapter.
This adapter implements the MailIntakeAdapter interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.
Notes
Responsibilities:
- This class is the ONLY place where `googleapiclient` is imported.\n- Gmail REST semantics are known.\n- `.execute()` is called.\nConstraints:
- Must remain thin and imperative.\n- Must not perform parsing or interpretation.\n- Must not expose Gmail-specific types beyond this class.\nInitialize the Gmail adapter.
Parameters:
Name Type Description Default
auth_provider MailIntakeAuthProvider Authentication provider capable of supplying valid Gmail API credentials.
required
user_id str Gmail user identifier. Defaults to \"me\".
'me'"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter-attributes","title":"Attributes","text":""},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.service","title":"service
property","text":"
service: Any\nLazily initialize and return the Gmail API service client.
Raises:
Type Description
MailIntakeAdapterError If the Gmail service cannot be initialized.
"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter-functions","title":"Functions","text":""},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full Gmail message by message ID.
Parameters:
Name Type Description Default
message_id str Gmail message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail message payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full Gmail thread by thread ID.
Parameters:
Name Type Description Default
thread_id str Gmail thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail thread payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/#mail_intake.adapters.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over message references matching the query.
Parameters:
Name Type Description Default
query str Gmail search query string.
required
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message_id and thread_id.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/base/","title":"Base","text":""},{"location":"adapters/base/#mail_intake.adapters.base","title":"mail_intake.adapters.base","text":""},{"location":"adapters/base/#mail_intake.adapters.base--summary","title":"Summary","text":"
Mail provider adapter contracts for Mail Intake.
This module defines the provider-agnostic adapter interface used for read-only mail ingestion.
Adapters encapsulate all provider-specific access logic and expose a minimal, normalized contract to the rest of the system. No provider-specific types or semantics should leak beyond implementations of this interface.
"},{"location":"adapters/base/#mail_intake.adapters.base-classes","title":"Classes","text":""},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter","title":"MailIntakeAdapter","text":"
Bases: ABC
Base adapter interface for mail providers.
Notes
Guarantees:
- Discover messages matching a query.\n- Retrieve full message payloads.\n- Retrieve full thread payloads.\nLifecycle:
- Adapters are intentionally read-only and must not mutate provider state.\n"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter-functions","title":"Functions","text":""},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_message","title":"fetch_message
abstractmethod","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full raw message by message identifier.
Parameters:
Name Type Description Default
message_id str Provider-specific message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native message payload (e.g., Gmail message JSON structure).
"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.fetch_thread","title":"fetch_thread
abstractmethod","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full raw thread by thread identifier.
Parameters:
Name Type Description Default
thread_id str Provider-specific thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native thread payload.
"},{"location":"adapters/base/#mail_intake.adapters.base.MailIntakeAdapter.iter_message_refs","title":"iter_message_refs
abstractmethod","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over lightweight message references matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[dict[str, str]] Iterator[dict[str, str]]: An iterator over lightweight message reference dictionaries.
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message and thread identifiers.
Notes
Guarantees:
- Implementations must yield dictionaries containing at least\n `message_id` and `thread_id`.\n Example
Typical yield:
{\n \"message_id\": \"...\",\n \"thread_id\": \"...\"\n}\n"},{"location":"adapters/gmail/","title":"Gmail","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail","title":"mail_intake.adapters.gmail","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail--summary","title":"Summary","text":"
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. All Gmail-specific behavior must be strictly contained within this module.
"},{"location":"adapters/gmail/#mail_intake.adapters.gmail-classes","title":"Classes","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter","title":"MailIntakeGmailAdapter","text":"
MailIntakeGmailAdapter(\n auth_provider: MailIntakeAuthProvider[Any],\n user_id: str = \"me\",\n)\n Bases: MailIntakeAdapter
Gmail read-only adapter.
This adapter implements the MailIntakeAdapter interface using the Gmail REST API. It translates the generic mail intake contract into Gmail-specific API calls.
Notes
Responsibilities:
- This class is the ONLY place where `googleapiclient` is imported.\n- Gmail REST semantics are known.\n- `.execute()` is called.\nConstraints:
- Must remain thin and imperative.\n- Must not perform parsing or interpretation.\n- Must not expose Gmail-specific types beyond this class.\nInitialize the Gmail adapter.
Parameters:
Name Type Description Default
auth_provider MailIntakeAuthProvider Authentication provider capable of supplying valid Gmail API credentials.
required
user_id str Gmail user identifier. Defaults to \"me\".
'me'"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter-attributes","title":"Attributes","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.service","title":"service
property","text":"
service: Any\nLazily initialize and return the Gmail API service client.
Raises:
Type Description
MailIntakeAdapterError If the Gmail service cannot be initialized.
"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter-functions","title":"Functions","text":""},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_message","title":"fetch_message","text":"
fetch_message(message_id: str) -> dict[str, Any]\nFetch a full Gmail message by message ID.
Parameters:
Name Type Description Default
message_id str Gmail message identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail message payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.fetch_thread","title":"fetch_thread","text":"
fetch_thread(thread_id: str) -> dict[str, Any]\nFetch a full Gmail thread by thread ID.
Parameters:
Name Type Description Default
thread_id str Gmail thread identifier.
required
Returns:
Type Description
dict[str, Any] dict[str, Any]: Provider-native Gmail thread payload.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"adapters/gmail/#mail_intake.adapters.gmail.MailIntakeGmailAdapter.iter_message_refs","title":"iter_message_refs","text":"
iter_message_refs(query: str) -> Iterator[dict[str, str]]\nIterate over message references matching the query.
Parameters:
Name Type Description Default
query str Gmail search query string.
required
Yields:
Type Description
dict[str, str] dict[str, str]: Dictionaries containing message_id and thread_id.
Raises:
Type Description
MailIntakeAdapterError If the Gmail API returns an error.
"},{"location":"auth/","title":"Auth","text":""},{"location":"auth/#mail_intake.auth","title":"mail_intake.auth","text":""},{"location":"auth/#mail_intake.auth--summary","title":"Summary","text":"
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. 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. Consumers should depend on the abstract interface and use concrete implementations only where explicitly required.
"},{"location":"auth/#mail_intake.auth--public-api","title":"Public API","text":"
MailIntakeAuthProviderMailIntakeGoogleAuth "},{"location":"auth/#mail_intake.auth-classes","title":"Classes","text":""},{"location":"auth/#mail_intake.auth.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"
Bases: ABC, Generic[T]
Abstract base class for authentication providers.
This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.
Notes
Responsibilities:
- 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.\nConstraints:
- 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.\n"},{"location":"auth/#mail_intake.auth.MailIntakeAuthProvider-functions","title":"Functions","text":""},{"location":"auth/#mail_intake.auth.MailIntakeAuthProvider.get_credentials","title":"get_credentials
abstractmethod","text":"
get_credentials() -> T\nRetrieve valid, provider-specific credentials.
Returns:
Name Type Description
T T Credentials of type T suitable for immediate use by the corresponding mail adapter.
Raises:
Type Description
Exception An authentication-specific exception indicating that credentials could not be obtained or validated.
Notes
Guarantees:
- 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.\n"},{"location":"auth/#mail_intake.auth.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"
MailIntakeGoogleAuth(\n credentials_path: str,\n store: CredentialStore[Any],\n scopes: Sequence[str],\n)\n Bases: MailIntakeAuthProvider
Google OAuth provider for Gmail access.
This provider implements the MailIntakeAuthProvider interface using Google's OAuth 2.0 flow and credential management libraries.
Notes
Responsibilities:
- 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.\nGuarantees:
- This class is synchronous by design and maintains a minimal\n internal state.\nInitialize the Google authentication provider.
Parameters:
Name Type Description Default
credentials_path str Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
required
store CredentialStore[Credentials] Credential store responsible for persisting and retrieving Google OAuth credentials.
required
scopes Sequence[str] OAuth scopes required for Gmail access.
required"},{"location":"auth/#mail_intake.auth.MailIntakeGoogleAuth-functions","title":"Functions","text":""},{"location":"auth/#mail_intake.auth.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"
get_credentials() -> Any\nRetrieve valid Google OAuth credentials.
Returns:
Name Type Description
Credentials Any A google.oauth2.credentials.Credentials instance suitable for use with Google API clients.
Raises:
Type Description
MailIntakeAuthError If credentials cannot be loaded, refreshed, or obtained via interactive authentication.
Notes
Lifecycle:
- 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.\n"},{"location":"auth/base/","title":"Base","text":""},{"location":"auth/base/#mail_intake.auth.base","title":"mail_intake.auth.base","text":""},{"location":"auth/base/#mail_intake.auth.base--summary","title":"Summary","text":"
Authentication provider contracts for Mail Intake.
This module defines the authentication abstraction layer used by mail adapters to obtain provider-specific credentials.
Authentication concerns are intentionally decoupled from adapter logic. Adapters depend only on this interface and must not be aware of how credentials are acquired, refreshed, or persisted.
"},{"location":"auth/base/#mail_intake.auth.base-classes","title":"Classes","text":""},{"location":"auth/base/#mail_intake.auth.base.MailIntakeAuthProvider","title":"MailIntakeAuthProvider","text":"
Bases: ABC, Generic[T]
Abstract base class for authentication providers.
This interface enforces a strict contract between authentication providers and mail adapters by requiring providers to explicitly declare the type of credentials they return.
Notes
Responsibilities:
- 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.\nConstraints:
- 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.\n"},{"location":"auth/base/#mail_intake.auth.base.MailIntakeAuthProvider-functions","title":"Functions","text":""},{"location":"auth/base/#mail_intake.auth.base.MailIntakeAuthProvider.get_credentials","title":"get_credentials
abstractmethod","text":"
get_credentials() -> T\nRetrieve valid, provider-specific credentials.
Returns:
Name Type Description
T T Credentials of type T suitable for immediate use by the corresponding mail adapter.
Raises:
Type Description
Exception An authentication-specific exception indicating that credentials could not be obtained or validated.
Notes
Guarantees:
- 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.\n"},{"location":"auth/google/","title":"Google","text":""},{"location":"auth/google/#mail_intake.auth.google","title":"mail_intake.auth.google","text":""},{"location":"auth/google/#mail_intake.auth.google--summary","title":"Summary","text":"
Google authentication provider implementation for Mail Intake.
This module provides a Google OAuth\u2013based 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. No Google authentication details should leak outside this module.
"},{"location":"auth/google/#mail_intake.auth.google-classes","title":"Classes","text":""},{"location":"auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth","title":"MailIntakeGoogleAuth","text":"
MailIntakeGoogleAuth(\n credentials_path: str,\n store: CredentialStore[Any],\n scopes: Sequence[str],\n)\n Bases: MailIntakeAuthProvider
Google OAuth provider for Gmail access.
This provider implements the MailIntakeAuthProvider interface using Google's OAuth 2.0 flow and credential management libraries.
Notes
Responsibilities:
- 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.\nGuarantees:
- This class is synchronous by design and maintains a minimal\n internal state.\nInitialize the Google authentication provider.
Parameters:
Name Type Description Default
credentials_path str Path to the Google OAuth client secrets file used to initiate the OAuth 2.0 flow.
required
store CredentialStore[Credentials] Credential store responsible for persisting and retrieving Google OAuth credentials.
required
scopes Sequence[str] OAuth scopes required for Gmail access.
required"},{"location":"auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth-functions","title":"Functions","text":""},{"location":"auth/google/#mail_intake.auth.google.MailIntakeGoogleAuth.get_credentials","title":"get_credentials","text":"
get_credentials() -> Any\nRetrieve valid Google OAuth credentials.
Returns:
Name Type Description
Credentials Any A google.oauth2.credentials.Credentials instance suitable for use with Google API clients.
Raises:
Type Description
MailIntakeAuthError If credentials cannot be loaded, refreshed, or obtained via interactive authentication.
Notes
Lifecycle:
- 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.\n"},{"location":"credentials/","title":"Credentials","text":""},{"location":"credentials/#mail_intake.credentials","title":"mail_intake.credentials","text":""},{"location":"credentials/#mail_intake.credentials--summary","title":"Summary","text":"
Credential persistence interfaces and implementations for Mail Intake.
This package defines the abstractions and concrete implementations used to persist authentication credentials across Mail Intake components.
The credential persistence layer is intentionally decoupled from authentication logic. Authentication providers are responsible for 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\u2013based 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.
"},{"location":"credentials/#mail_intake.credentials--public-api","title":"Public API","text":"
CredentialStorePickleCredentialStoreRedisCredentialStore "},{"location":"credentials/#mail_intake.credentials-classes","title":"Classes","text":""},{"location":"credentials/#mail_intake.credentials.CredentialStore","title":"CredentialStore","text":"
Bases: ABC, Generic[T]
Abstract base class defining a generic persistence interface.
Used for authentication credentials across different backends.
Notes
Responsibilities:
- Provide persistent storage separating life-cycle management from\n storage mechanics.\n- Keep implementation focused only on persistence.\nConstraints:
- 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.\n"},{"location":"credentials/#mail_intake.credentials.CredentialStore-functions","title":"Functions","text":""},{"location":"credentials/#mail_intake.credentials.CredentialStore.clear","title":"clear
abstractmethod","text":"
clear() -> None\nRemove any persisted credentials from the store.
Notes
Lifecycle:
- 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\nGuarantees:
- Implementations should treat this operation as idempotent\n"},{"location":"credentials/#mail_intake.credentials.CredentialStore.load","title":"load
abstractmethod","text":"
load() -> T | None\nLoad previously persisted credentials.
Returns:
Type Description
T | 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\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.\n"},{"location":"credentials/#mail_intake.credentials.CredentialStore.save","title":"save
abstractmethod","text":"
save(credentials: T) -> None\nPersist credentials to the underlying storage backend.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required 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\nResponsibilities:
- Ensuring durability appropriate to the deployment context\n- Applying encryption or access controls where required\n- Overwriting any previously stored credentials\n"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore","title":"PickleCredentialStore","text":"
PickleCredentialStore(path: str)\n Bases: CredentialStore[T]
Filesystem-backed credential store using pickle serialization.
This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.
Notes
Guarantees:
- Stores credentials on the local filesystem.\n- Uses `pickle` for serialization and deserialization.\n- Does not provide encryption, locking, or concurrency guarantees.\nConstraints:
- Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.\nInitialize a pickle-backed credential store.
Parameters:
Name Type Description Default
path str Filesystem path where credentials will be stored. The file will be created or overwritten as needed.
required"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore-functions","title":"Functions","text":""},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove persisted credentials from the local filesystem.
Notes
Lifecycle:
- This method deletes the credential file if it exists and should be treated as an idempotent operation\n"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from the local filesystem.
Returns:
Type Description
T | 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\n deserialized, this method returns `None`.\n- The store does not attempt to validate or interpret the\n returned credentials.\n"},{"location":"credentials/#mail_intake.credentials.PickleCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to the local filesystem.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- Any previously stored credentials at the configured path are overwritten\n"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore","title":"RedisCredentialStore","text":"
RedisCredentialStore(\n redis_client: Any,\n key: str,\n serialize: Callable[[T], bytes],\n deserialize: Callable[[bytes], T],\n ttl_seconds: int | None = None,\n)\n Bases: CredentialStore[T]
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.
Notes
Responsibilities:
- 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.\nGuarantees:
- 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.\nInitialize a Redis-backed credential store.
Parameters:
Name Type Description Default
redis_client Any Initialized Redis client instance used for persistence.
required
key str Storage key under which credentials are persisted.
required
serialize Callable[[T], bytes] Callable that encodes credentials to bytes for storage.
required
deserialize Callable[[bytes], T] Callable that decodes stored bytes back into credentials.
required
ttl_seconds int | None Optional time-to-live in seconds after which stored credentials expire automatically. None disables expiry.
None"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore-functions","title":"Functions","text":""},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove stored credentials from Redis.
Notes
Lifecycle:
- This operation deletes the configured Redis key if it exists\n- Implementations should treat this method as idempotent\n"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from Redis.
Returns:
Type Description
T | 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\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.\n"},{"location":"credentials/#mail_intake.credentials.RedisCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to Redis.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- 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\n"},{"location":"credentials/pickle/","title":"Pickle","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle","title":"mail_intake.credentials.pickle","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle--summary","title":"Summary","text":"
Local filesystem\u2013based credential persistence for Mail Intake.
This module provides a file-backed implementation of the CredentialStore abstraction using Python's pickle module.
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 serialization, this implementation is not suitable for distributed or untrusted environments.
"},{"location":"credentials/pickle/#mail_intake.credentials.pickle-classes","title":"Classes","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore","title":"PickleCredentialStore","text":"
PickleCredentialStore(path: str)\n Bases: CredentialStore[T]
Filesystem-backed credential store using pickle serialization.
This store persists credentials as a pickled object on the local filesystem. It is a simple implementation intended primarily for development, testing, and single-process execution contexts.
Notes
Guarantees:
- Stores credentials on the local filesystem.\n- Uses `pickle` for serialization and deserialization.\n- Does not provide encryption, locking, or concurrency guarantees.\nConstraints:
- Credential lifecycle management, validation, and refresh logic are\n explicitly out of scope for this class.\nInitialize a pickle-backed credential store.
Parameters:
Name Type Description Default
path str Filesystem path where credentials will be stored. The file will be created or overwritten as needed.
required"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore-functions","title":"Functions","text":""},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove persisted credentials from the local filesystem.
Notes
Lifecycle:
- This method deletes the credential file if it exists and should be treated as an idempotent operation\n"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from the local filesystem.
Returns:
Type Description
T | 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\n deserialized, this method returns `None`.\n- The store does not attempt to validate or interpret the\n returned credentials.\n"},{"location":"credentials/pickle/#mail_intake.credentials.pickle.PickleCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to the local filesystem.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- Any previously stored credentials at the configured path are overwritten\n"},{"location":"credentials/redis/","title":"Redis","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis","title":"mail_intake.credentials.redis","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis--summary","title":"Summary","text":"
Redis-backed credential persistence for Mail Intake.
This module provides a Redis-based implementation of the CredentialStore abstraction, enabling credential persistence across distributed and horizontally scaled deployments.
The Redis credential store is designed for environments where authentication credentials must be shared safely across multiple 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. This module is responsible solely for persistence concerns. Credential validation, refresh, rotation, and acquisition remain the responsibility of authentication provider implementations.
"},{"location":"credentials/redis/#mail_intake.credentials.redis-classes","title":"Classes","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore","title":"RedisCredentialStore","text":"
RedisCredentialStore(\n redis_client: Any,\n key: str,\n serialize: Callable[[T], bytes],\n deserialize: Callable[[bytes], T],\n ttl_seconds: int | None = None,\n)\n Bases: CredentialStore[T]
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.
Notes
Responsibilities:
- 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.\nGuarantees:
- 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.\nInitialize a Redis-backed credential store.
Parameters:
Name Type Description Default
redis_client Any Initialized Redis client instance used for persistence.
required
key str Storage key under which credentials are persisted.
required
serialize Callable[[T], bytes] Callable that encodes credentials to bytes for storage.
required
deserialize Callable[[bytes], T] Callable that decodes stored bytes back into credentials.
required
ttl_seconds int | None Optional time-to-live in seconds after which stored credentials expire automatically. None disables expiry.
None"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore-functions","title":"Functions","text":""},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.clear","title":"clear","text":"
clear() -> None\nRemove stored credentials from Redis.
Notes
Lifecycle:
- This operation deletes the configured Redis key if it exists\n- Implementations should treat this method as idempotent\n"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.load","title":"load","text":"
load() -> T | None\nLoad credentials from Redis.
Returns:
Type Description
T | 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\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.\n"},{"location":"credentials/redis/#mail_intake.credentials.redis.RedisCredentialStore.save","title":"save","text":"
save(credentials: T) -> None\nPersist credentials to Redis.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required Notes
Responsibilities:
- 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\n"},{"location":"credentials/store/","title":"Store","text":""},{"location":"credentials/store/#mail_intake.credentials.store","title":"mail_intake.credentials.store","text":""},{"location":"credentials/store/#mail_intake.credentials.store--summary","title":"Summary","text":"
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 between credential lifecycle management and credential storage. Authentication providers are responsible for acquiring, validating, refreshing, and revoking credentials, while concrete store implementations are responsible solely for persistence concerns.
By remaining agnostic to credential structure, serialization format, and storage backend, this module enables multiple persistence strategies\u2014such as local files, in-memory caches, distributed stores, or secrets managers\u2014without coupling authentication logic to any specific storage mechanism.
"},{"location":"credentials/store/#mail_intake.credentials.store-classes","title":"Classes","text":""},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore","title":"CredentialStore","text":"
Bases: ABC, Generic[T]
Abstract base class defining a generic persistence interface.
Used for authentication credentials across different backends.
Notes
Responsibilities:
- Provide persistent storage separating life-cycle management from\n storage mechanics.\n- Keep implementation focused only on persistence.\nConstraints:
- 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.\n"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore-functions","title":"Functions","text":""},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.clear","title":"clear
abstractmethod","text":"
clear() -> None\nRemove any persisted credentials from the store.
Notes
Lifecycle:
- 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\nGuarantees:
- Implementations should treat this operation as idempotent\n"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.load","title":"load
abstractmethod","text":"
load() -> T | None\nLoad previously persisted credentials.
Returns:
Type Description
T | 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\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.\n"},{"location":"credentials/store/#mail_intake.credentials.store.CredentialStore.save","title":"save
abstractmethod","text":"
save(credentials: T) -> None\nPersist credentials to the underlying storage backend.
Parameters:
Name Type Description Default
credentials T The credential object to persist.
required 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\nResponsibilities:
- Ensuring durability appropriate to the deployment context\n- Applying encryption or access controls where required\n- Overwriting any previously stored credentials\n"},{"location":"ingestion/","title":"Ingestion","text":""},{"location":"ingestion/#mail_intake.ingestion","title":"mail_intake.ingestion","text":""},{"location":"ingestion/#mail_intake.ingestion--summary","title":"Summary","text":"
Mail ingestion orchestration for Mail Intake.
This package contains high-level ingestion components responsible for coordinating mail retrieval, parsing, normalization, and model construction.
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. Consumers are expected to construct a mail adapter and pass it to the ingestion layer to begin processing messages and threads.
"},{"location":"ingestion/#mail_intake.ingestion--public-api","title":"Public API","text":"
"},{"location":"ingestion/#mail_intake.ingestion-classes","title":"Classes","text":""},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader","title":"MailIntakeReader","text":"
MailIntakeReader(adapter: MailIntakeAdapter)\nHigh-level read-only ingestion interface.
Notes
Responsibilities:
- 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.\nConstraints:
- This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.\nInitialize the mail reader.
Parameters:
Name Type Description Default
adapter MailIntakeAdapter Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
required"},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader-functions","title":"Functions","text":""},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader.iter_messages","title":"iter_messages","text":"
iter_messages(query: str) -> Iterator[MailIntakeMessage]\nIterate over parsed messages matching a provider query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Yields:
Name Type Description
MailIntakeMessage MailIntakeMessage Fully parsed and normalized MailIntakeMessage instances.
Raises:
Type Description
MailIntakeParsingError If a message cannot be parsed.
"},{"location":"ingestion/#mail_intake.ingestion.MailIntakeReader.iter_threads","title":"iter_threads","text":"
iter_threads(query: str) -> Iterator[MailIntakeThread]\nIterate over threads constructed from messages matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[MailIntakeThread] Iterator[MailIntakeThread]: An iterator over MailIntakeThread instances.
Raises:
Type Description
`MailIntakeParsingError` If a message cannot be parsed.
Notes
Guarantees:
- Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages.\n"},{"location":"ingestion/reader/","title":"Reader","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader","title":"mail_intake.ingestion.reader","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader--summary","title":"Summary","text":"
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. No provider-specific logic or API semantics are permitted in this layer.
"},{"location":"ingestion/reader/#mail_intake.ingestion.reader-classes","title":"Classes","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader","title":"MailIntakeReader","text":"
MailIntakeReader(adapter: MailIntakeAdapter)\nHigh-level read-only ingestion interface.
Notes
Responsibilities:
- 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.\nConstraints:
- This class is intentionally: Provider-agnostic, stateless beyond\n iteration scope, read-only.\nInitialize the mail reader.
Parameters:
Name Type Description Default
adapter MailIntakeAdapter Mail adapter implementation used to retrieve raw messages and threads from a mail provider.
required"},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader-functions","title":"Functions","text":""},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_messages","title":"iter_messages","text":"
iter_messages(query: str) -> Iterator[MailIntakeMessage]\nIterate over parsed messages matching a provider query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Yields:
Name Type Description
MailIntakeMessage MailIntakeMessage Fully parsed and normalized MailIntakeMessage instances.
Raises:
Type Description
MailIntakeParsingError If a message cannot be parsed.
"},{"location":"ingestion/reader/#mail_intake.ingestion.reader.MailIntakeReader.iter_threads","title":"iter_threads","text":"
iter_threads(query: str) -> Iterator[MailIntakeThread]\nIterate over threads constructed from messages matching a query.
Parameters:
Name Type Description Default
query str Provider-specific query string used to filter messages.
required
Returns:
Type Description
Iterator[MailIntakeThread] Iterator[MailIntakeThread]: An iterator over MailIntakeThread instances.
Raises:
Type Description
`MailIntakeParsingError` If a message cannot be parsed.
Notes
Guarantees:
- Messages are grouped by `thread_id` and yielded as complete\n thread objects containing all associated messages.\n"},{"location":"ingestion/reader/#mail_intake.ingestion.reader-functions","title":"Functions","text":""},{"location":"models/","title":"Models","text":""},{"location":"models/#mail_intake.models","title":"mail_intake.models","text":""},{"location":"models/#mail_intake.models--summary","title":"Summary","text":"
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. These models form the core internal data contract of the library.
"},{"location":"models/#mail_intake.models--public-api","title":"Public API","text":"
MailIntakeMessageMailIntakeThread "},{"location":"models/#mail_intake.models-classes","title":"Classes","text":""},{"location":"models/#mail_intake.models.MailIntakeMessage","title":"MailIntakeMessage
dataclass","text":"
MailIntakeMessage(\n message_id: str,\n thread_id: str,\n timestamp: datetime,\n from_email: str,\n from_name: str | None,\n subject: str,\n body_text: str,\n snippet: str,\n raw_headers: dict[str, str],\n)\nCanonical internal representation of a single email message.
Notes
Guarantees:
- 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.\nConstraints:
- No provider-specific identifiers, payloads, or API semantics\n should appear in this model.\n"},{"location":"models/#mail_intake.models.MailIntakeMessage-attributes","title":"Attributes","text":""},{"location":"models/#mail_intake.models.MailIntakeMessage.body_text","title":"body_text
instance-attribute","text":"
body_text: str\nExtracted plain-text body content of the message.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.from_email","title":"from_email
instance-attribute","text":"
from_email: str\nSender email address.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.from_name","title":"from_name
instance-attribute","text":"
from_name: str | None\nOptional human-readable sender name.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.message_id","title":"message_id
instance-attribute","text":"
message_id: str\nProvider-specific message identifier.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.raw_headers","title":"raw_headers
instance-attribute","text":"
raw_headers: dict[str, str]\nNormalized mapping of message headers (header name \u2192 value).
"},{"location":"models/#mail_intake.models.MailIntakeMessage.snippet","title":"snippet
instance-attribute","text":"
snippet: str\nShort provider-supplied preview snippet of the message.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.subject","title":"subject
instance-attribute","text":"
subject: str\nRaw subject line of the message.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier to which this message belongs.
"},{"location":"models/#mail_intake.models.MailIntakeMessage.timestamp","title":"timestamp
instance-attribute","text":"
timestamp: datetime\nMessage timestamp as a timezone-naive UTC datetime.
"},{"location":"models/#mail_intake.models.MailIntakeThread","title":"MailIntakeThread
dataclass","text":"
MailIntakeThread(\n thread_id: str,\n normalized_subject: str,\n participants: set[str] = ...,\n messages: list[MailIntakeMessage] = ...,\n last_activity_at: datetime | None = ...,\n)\nCanonical internal representation of an email thread.
Notes
Guarantees:
- 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.\n"},{"location":"models/#mail_intake.models.MailIntakeThread-attributes","title":"Attributes","text":""},{"location":"models/#mail_intake.models.MailIntakeThread.last_activity_at","title":"last_activity_at
class-attribute instance-attribute","text":"
last_activity_at: datetime | None = None\nTimestamp of the most recent message in the thread.
"},{"location":"models/#mail_intake.models.MailIntakeThread.messages","title":"messages
class-attribute instance-attribute","text":"
messages: list[MailIntakeMessage] = field(\n default_factory=list\n)\nOrdered list of messages belonging to this thread.
"},{"location":"models/#mail_intake.models.MailIntakeThread.normalized_subject","title":"normalized_subject
instance-attribute","text":"
normalized_subject: str\nNormalized subject line used to group related messages.
"},{"location":"models/#mail_intake.models.MailIntakeThread.participants","title":"participants
class-attribute instance-attribute","text":"
participants: set[str] = field(default_factory=set)\nSet of unique participant email addresses observed in the thread.
"},{"location":"models/#mail_intake.models.MailIntakeThread.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier.
"},{"location":"models/#mail_intake.models.MailIntakeThread-functions","title":"Functions","text":""},{"location":"models/#mail_intake.models.MailIntakeThread.add_message","title":"add_message","text":"
add_message(message: MailIntakeMessage) -> None\nAdd a message to the thread and update derived fields.
Parameters:
Name Type Description Default
message MailIntakeMessage Parsed mail message to add to the thread.
required Notes
Responsibilities:
- Appends the message to the thread.\n- Tracks unique participants.\n- Updates the last activity timestamp.\n"},{"location":"models/message/","title":"Message","text":""},{"location":"models/message/#mail_intake.models.message","title":"mail_intake.models.message","text":""},{"location":"models/message/#mail_intake.models.message--summary","title":"Summary","text":"
Message domain models for Mail Intake.
This module defines the canonical, provider-agnostic representation of an individual email message as used internally by the Mail Intake ingestion pipeline.
Models in this module are safe to persist and must not contain any provider-specific fields or semantics.
"},{"location":"models/message/#mail_intake.models.message-classes","title":"Classes","text":""},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage","title":"MailIntakeMessage
dataclass","text":"
MailIntakeMessage(\n message_id: str,\n thread_id: str,\n timestamp: datetime,\n from_email: str,\n from_name: str | None,\n subject: str,\n body_text: str,\n snippet: str,\n raw_headers: dict[str, str],\n)\nCanonical internal representation of a single email message.
Notes
Guarantees:
- 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.\nConstraints:
- No provider-specific identifiers, payloads, or API semantics\n should appear in this model.\n"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage-attributes","title":"Attributes","text":""},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.body_text","title":"body_text
instance-attribute","text":"
body_text: str\nExtracted plain-text body content of the message.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.from_email","title":"from_email
instance-attribute","text":"
from_email: str\nSender email address.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.from_name","title":"from_name
instance-attribute","text":"
from_name: str | None\nOptional human-readable sender name.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.message_id","title":"message_id
instance-attribute","text":"
message_id: str\nProvider-specific message identifier.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.raw_headers","title":"raw_headers
instance-attribute","text":"
raw_headers: dict[str, str]\nNormalized mapping of message headers (header name \u2192 value).
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.snippet","title":"snippet
instance-attribute","text":"
snippet: str\nShort provider-supplied preview snippet of the message.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.subject","title":"subject
instance-attribute","text":"
subject: str\nRaw subject line of the message.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier to which this message belongs.
"},{"location":"models/message/#mail_intake.models.message.MailIntakeMessage.timestamp","title":"timestamp
instance-attribute","text":"
timestamp: datetime\nMessage timestamp as a timezone-naive UTC datetime.
"},{"location":"models/thread/","title":"Thread","text":""},{"location":"models/thread/#mail_intake.models.thread","title":"mail_intake.models.thread","text":""},{"location":"models/thread/#mail_intake.models.thread--summary","title":"Summary","text":"
Thread domain models for Mail Intake.
This module defines the canonical, provider-agnostic representation of an email thread as used internally by the Mail Intake ingestion pipeline.
Threads group related messages and serve as the primary unit of reasoning for higher-level correspondence workflows.
"},{"location":"models/thread/#mail_intake.models.thread-classes","title":"Classes","text":""},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread","title":"MailIntakeThread
dataclass","text":"
MailIntakeThread(\n thread_id: str,\n normalized_subject: str,\n participants: set[str] = ...,\n messages: list[MailIntakeMessage] = ...,\n last_activity_at: datetime | None = ...,\n)\nCanonical internal representation of an email thread.
Notes
Guarantees:
- 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.\n"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread-attributes","title":"Attributes","text":""},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.last_activity_at","title":"last_activity_at
class-attribute instance-attribute","text":"
last_activity_at: datetime | None = None\nTimestamp of the most recent message in the thread.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.messages","title":"messages
class-attribute instance-attribute","text":"
messages: list[MailIntakeMessage] = field(\n default_factory=list\n)\nOrdered list of messages belonging to this thread.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.normalized_subject","title":"normalized_subject
instance-attribute","text":"
normalized_subject: str\nNormalized subject line used to group related messages.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.participants","title":"participants
class-attribute instance-attribute","text":"
participants: set[str] = field(default_factory=set)\nSet of unique participant email addresses observed in the thread.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.thread_id","title":"thread_id
instance-attribute","text":"
thread_id: str\nProvider-specific thread identifier.
"},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread-functions","title":"Functions","text":""},{"location":"models/thread/#mail_intake.models.thread.MailIntakeThread.add_message","title":"add_message","text":"
add_message(message: MailIntakeMessage) -> None\nAdd a message to the thread and update derived fields.
Parameters:
Name Type Description Default
message MailIntakeMessage Parsed mail message to add to the thread.
required Notes
Responsibilities:
- Appends the message to the thread.\n- Tracks unique participants.\n- Updates the last activity timestamp.\n"},{"location":"parsers/","title":"Parsers","text":""},{"location":"parsers/#mail_intake.parsers","title":"mail_intake.parsers","text":""},{"location":"parsers/#mail_intake.parsers--summary","title":"Summary","text":"
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. This package does not:
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.
"},{"location":"parsers/#mail_intake.parsers--public-api","title":"Public API","text":"
extract_bodyparse_headersextract_sendernormalize_subject "},{"location":"parsers/#mail_intake.parsers-functions","title":"Functions","text":""},{"location":"parsers/#mail_intake.parsers.extract_body","title":"extract_body","text":"
extract_body(payload: dict[str, Any]) -> str\nExtract the best-effort message body from a Gmail payload.
Priority:
text/plaintext/html (stripped to text)Single-part body Empty string (if nothing usable found) Parameters:
Name Type Description Default
payload dict[str, Any] Provider-native message payload dictionary.
required
Returns:
Name Type Description
str str Extracted plain-text message body.
"},{"location":"parsers/#mail_intake.parsers.extract_sender","title":"extract_sender","text":"
extract_sender(\n headers: dict[str, str],\n) -> tuple[str, str | None]\nExtract sender email and optional display name from headers.
Parameters:
Name Type Description Default
headers dict[str, str] Normalized header dictionary as returned by parse_headers().
required
Returns:
Type Description
tuple[str, str | None] tuple[str, str | None]: A tuple (email, name) where email is the sender email address and name is the display name, or None if unavailable.
Notes
Responsibilities:
- This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n Example
Typical values:
\"John Doe <john@example.com>\" -> (\"john@example.com\", \"John Doe\")\"john@example.com\" -> (\"john@example.com\", None) "},{"location":"parsers/#mail_intake.parsers.normalize_subject","title":"normalize_subject","text":"
normalize_subject(subject: str) -> str\nNormalize an email subject for thread-level comparison.
Parameters:
Name Type Description Default
subject str Raw subject line from a message header.
required
Returns:
Name Type Description
str str Normalized subject string suitable for thread grouping.
Notes
Responsibilities:
- 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).\nGuarantees:
- This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject.\n"},{"location":"parsers/#mail_intake.parsers.parse_headers","title":"parse_headers","text":"
parse_headers(\n raw_headers: list[dict[str, str]],\n) -> dict[str, str]\nConvert a list of Gmail-style headers into a normalized dict.
Parameters:
Name Type Description Default
raw_headers list[dict[str, str]] List of header dictionaries, each containing name and value keys.
required
Returns:
Type Description
dict[str, str] dict[str, str]: Dictionary mapping lowercase header names to stripped values.
Notes
Guarantees:
- 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 Example
Typical usage:
Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\nOutput:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n"},{"location":"parsers/body/","title":"Body","text":""},{"location":"parsers/body/#mail_intake.parsers.body","title":"mail_intake.parsers.body","text":""},{"location":"parsers/body/#mail_intake.parsers.body--summary","title":"Summary","text":"
Message body extraction utilities for Mail Intake.
This module contains helper functions for extracting a best-effort plain-text body from provider-native message payloads.
The logic is intentionally tolerant of malformed or partial data and prefers human-readable text over fidelity to original formatting.
"},{"location":"parsers/body/#mail_intake.parsers.body-classes","title":"Classes","text":""},{"location":"parsers/body/#mail_intake.parsers.body-functions","title":"Functions","text":""},{"location":"parsers/body/#mail_intake.parsers.body.extract_body","title":"extract_body","text":"
extract_body(payload: dict[str, Any]) -> str\nExtract the best-effort message body from a Gmail payload.
Priority:
text/plaintext/html (stripped to text)Single-part body Empty string (if nothing usable found) Parameters:
Name Type Description Default
payload dict[str, Any] Provider-native message payload dictionary.
required
Returns:
Name Type Description
str str Extracted plain-text message body.
"},{"location":"parsers/headers/","title":"Headers","text":""},{"location":"parsers/headers/#mail_intake.parsers.headers","title":"mail_intake.parsers.headers","text":""},{"location":"parsers/headers/#mail_intake.parsers.headers--summary","title":"Summary","text":"
Message header parsing utilities for Mail Intake.
This module provides helper functions for normalizing and extracting useful information from provider-native message headers.
The functions here are intentionally simple and tolerant of malformed or incomplete header data.
"},{"location":"parsers/headers/#mail_intake.parsers.headers-functions","title":"Functions","text":""},{"location":"parsers/headers/#mail_intake.parsers.headers.extract_sender","title":"extract_sender","text":"
extract_sender(\n headers: dict[str, str],\n) -> tuple[str, str | None]\nExtract sender email and optional display name from headers.
Parameters:
Name Type Description Default
headers dict[str, str] Normalized header dictionary as returned by parse_headers().
required
Returns:
Type Description
tuple[str, str | None] tuple[str, str | None]: A tuple (email, name) where email is the sender email address and name is the display name, or None if unavailable.
Notes
Responsibilities:
- This function parses the `From` header and attempts to extract\n sender email address and optional human-readable display name.\n Example
Typical values:
\"John Doe <john@example.com>\" -> (\"john@example.com\", \"John Doe\")\"john@example.com\" -> (\"john@example.com\", None) "},{"location":"parsers/headers/#mail_intake.parsers.headers.parse_headers","title":"parse_headers","text":"
parse_headers(\n raw_headers: list[dict[str, str]],\n) -> dict[str, str]\nConvert a list of Gmail-style headers into a normalized dict.
Parameters:
Name Type Description Default
raw_headers list[dict[str, str]] List of header dictionaries, each containing name and value keys.
required
Returns:
Type Description
dict[str, str] dict[str, str]: Dictionary mapping lowercase header names to stripped values.
Notes
Guarantees:
- 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 Example
Typical usage:
Input:\n [\n {\"name\": \"From\", \"value\": \"John Doe <john@example.com>\"},\n {\"name\": \"Subject\", \"value\": \"Re: Interview Update\"},\n ]\n\nOutput:\n {\n \"from\": \"John Doe <john@example.com>\",\n \"subject\": \"Re: Interview Update\",\n }\n"},{"location":"parsers/subject/","title":"Subject","text":""},{"location":"parsers/subject/#mail_intake.parsers.subject","title":"mail_intake.parsers.subject","text":""},{"location":"parsers/subject/#mail_intake.parsers.subject--summary","title":"Summary","text":"
Subject line normalization utilities for Mail Intake.
This module provides helper functions for normalizing email subject lines to enable reliable thread-level comparison and grouping.
Normalization is intentionally conservative to avoid altering semantic meaning while removing common reply and forward prefixes.
"},{"location":"parsers/subject/#mail_intake.parsers.subject-functions","title":"Functions","text":""},{"location":"parsers/subject/#mail_intake.parsers.subject.normalize_subject","title":"normalize_subject","text":"
normalize_subject(subject: str) -> str\nNormalize an email subject for thread-level comparison.
Parameters:
Name Type Description Default
subject str Raw subject line from a message header.
required
Returns:
Name Type Description
str str Normalized subject string suitable for thread grouping.
Notes
Responsibilities:
- 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).\nGuarantees:
- This function is intentionally conservative and avoids aggressive\n transformations that could alter the semantic meaning of the subject.\n"}]}
\ No newline at end of file
diff --git a/mail-intake/lib/sitemap.xml.gz b/mail-intake/lib/sitemap.xml.gz
index e496a0d..89851db 100644
Binary files a/mail-intake/lib/sitemap.xml.gz and b/mail-intake/lib/sitemap.xml.gz differ
diff --git a/mail-intake/wiki/01_overview/index.html b/mail-intake/wiki/01_overview/index.html
new file mode 100644
index 0000000..4d22ac2
--- /dev/null
+++ b/mail-intake/wiki/01_overview/index.html
@@ -0,0 +1,752 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Overview - Mail Intake Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+🧱 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
+
Layers:
+
+Adapters (mail_intake.adapters) — provider-specific, read-only
+ transport. Return provider-native payloads; never interpret them.Auth (mail_intake.auth) — credential acquisition and lifecycle
+ management, decoupled from adapters.Credentials (mail_intake.credentials) — persistence of auth tokens;
+ PickleCredentialStore locally, RedisCredentialStore for production.Parsers (mail_intake.parsers) — extract headers, body text, sender,
+ and normalized subjects from provider payloads.Ingestion (mail_intake.ingestion) — MailIntakeReader wires an
+ adapter + parsers into iterators over canonical models.Models (mail_intake.models) — provider-agnostic MailIntakeMessage
+ and MailIntakeThread.
+📦 Domain models
+MailIntakeMessage:
+
+
+
+Field
+Type
+Meaning
+
+
+
+
+message_idstrProvider message id
+
+
+thread_idstrConversation thread id
+
+
+timestampdatetimeMessage timestamp
+
+
+from_emailstrSender email
+
+
+from_namestr \| NoneSender display name
+
+
+subjectstrMessage subject
+
+
+body_textstrExtracted plain-text body
+
+
+snippetstrProvider snippet
+
+
+raw_headersdict[str, str]Unmodified headers
+
+
+
+MailIntakeThread:
+
+
+
+Field
+Type
+Meaning
+
+
+
+
+thread_idstrConversation id
+
+
+normalized_subjectstrNormalized subject (threads share one)
+
+
+participantsset[str]Distinct senders
+
+
+messageslist[MailIntakeMessage]Ordered messages
+
+
+last_activity_atdatetime \| NoneLatest 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/mail-intake/wiki/02_how_to_use/index.html b/mail-intake/wiki/02_how_to_use/index.html
new file mode 100644
index 0000000..2e6b1d9
--- /dev/null
+++ b/mail-intake/wiki/02_how_to_use/index.html
@@ -0,0 +1,701 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
How to Use - Mail Intake Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+🖥️ 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:
+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:
+store = RedisCredentialStore ( redis_client = redis_client ) # production
+
📥 Ingesting messages
+Build an adapter and a reader, then iterate:
+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:
+message . message_id # provider id
+message . thread_id
+message . body_text # plain-text body
+message . raw_headers # unmodified headers dict
+
🔖 Ingesting threads
+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:
+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
+
+Provide OAuth credentials via a file path and a credential store.
+Build the MailIntakeGoogleAuth provider with the Gmail read-only scope.
+Wrap the adapter in a MailIntakeReader.
+Consume iter_messages / iter_threads; never call provider APIs directly.
+
+📚 Read Next
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/mail-intake/wiki/03_extending/index.html b/mail-intake/wiki/03_extending/index.html
new file mode 100644
index 0000000..d6ce66f
--- /dev/null
+++ b/mail-intake/wiki/03_extending/index.html
@@ -0,0 +1,717 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extending Mail Intake - Mail Intake Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+🧩 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:
+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:
+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:
+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
+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
+
+Implement the public contract — never subclass built-in adapters.
+Keep transport in the adapter, parsing in parsers, auth in the provider.
+Return the provider-native payload and let parsers normalize it.
+Inject dependencies explicitly — no global state or env reads.
+
+📚 Read Next
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/mail-intake/wiki/04_development/index.html b/mail-intake/wiki/04_development/index.html
new file mode 100644
index 0000000..1dc9f68
--- /dev/null
+++ b/mail-intake/wiki/04_development/index.html
@@ -0,0 +1,695 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Development - Mail Intake Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+🛠️ Development
+Working on mail-intake itself.
+📂 Repository layout
+
+
+
+Path
+Purpose
+
+
+
+
+mail_intake/The library package (adapters, auth, credentials, parsers, ingestion, models)
+
+
+mail_intake/*.pyiType 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
+ -m venv .venv
+ 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):
+
+Coverage spans ingestion flows, credential stores, parsers, and auth against
+mock providers.
+✅ Quality gates
+The CI quality gate runs, matching the Drone pipeline:
+ --check .
+ check .
+
📝 Building documentation (docforge)
+The site is generated by docforgesite/{kind}:
+ 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:
+ serve --lib
+ serve --wiki
+ serve --mcp
+
📚 Read Next
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/mail-intake/wiki/404.html b/mail-intake/wiki/404.html
new file mode 100644
index 0000000..e422f1c
--- /dev/null
+++ b/mail-intake/wiki/404.html
@@ -0,0 +1,478 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Mail Intake Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 404 - Not found
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/mail-intake/wiki/assets/images/favicon.png b/mail-intake/wiki/assets/images/favicon.png
new file mode 100644
index 0000000..1cf13b9
Binary files /dev/null and b/mail-intake/wiki/assets/images/favicon.png differ
diff --git a/mail-intake/wiki/assets/javascripts/bundle.f55a23d4.min.js b/mail-intake/wiki/assets/javascripts/bundle.f55a23d4.min.js
new file mode 100644
index 0000000..01a46ad
--- /dev/null
+++ b/mail-intake/wiki/assets/javascripts/bundle.f55a23d4.min.js
@@ -0,0 +1,16 @@
+"use strict";(()=>{var Wi=Object.create;var gr=Object.defineProperty;var Vi=Object.getOwnPropertyDescriptor;var Di=Object.getOwnPropertyNames,Vt=Object.getOwnPropertySymbols,zi=Object.getPrototypeOf,yr=Object.prototype.hasOwnProperty,ao=Object.prototype.propertyIsEnumerable;var io=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,$=(e,t)=>{for(var r in t||(t={}))yr.call(t,r)&&io(e,r,t[r]);if(Vt)for(var r of Vt(t))ao.call(t,r)&&io(e,r,t[r]);return e};var so=(e,t)=>{var r={};for(var o in e)yr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Vt)for(var o of Vt(e))t.indexOf(o)<0&&ao.call(e,o)&&(r[o]=e[o]);return r};var xr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Ni=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Di(t))!yr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=Vi(t,n))||o.enumerable});return e};var Lt=(e,t,r)=>(r=e!=null?Wi(zi(e)):{},Ni(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var co=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var lo=xr((Er,po)=>{(function(e,t){typeof Er=="object"&&typeof po!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,(function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(k){return!!(k&&k!==document&&k.nodeName!=="HTML"&&k.nodeName!=="BODY"&&"classList"in k&&"contains"in k.classList)}function p(k){var ft=k.type,qe=k.tagName;return!!(qe==="INPUT"&&a[ft]&&!k.readOnly||qe==="TEXTAREA"&&!k.readOnly||k.isContentEditable)}function c(k){k.classList.contains("focus-visible")||(k.classList.add("focus-visible"),k.setAttribute("data-focus-visible-added",""))}function l(k){k.hasAttribute("data-focus-visible-added")&&(k.classList.remove("focus-visible"),k.removeAttribute("data-focus-visible-added"))}function f(k){k.metaKey||k.altKey||k.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(k){o=!1}function d(k){s(k.target)&&(o||p(k.target))&&c(k.target)}function y(k){s(k.target)&&(k.target.classList.contains("focus-visible")||k.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(k.target))}function L(k){document.visibilityState==="hidden"&&(n&&(o=!0),X())}function X(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function ee(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(k){k.target.nodeName&&k.target.nodeName.toLowerCase()==="html"||(o=!1,ee())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",L,!0),X(),r.addEventListener("focus",d,!0),r.addEventListener("blur",y,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)}))});var qr=xr((dy,On)=>{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var $a=/["'&<>]/;On.exports=Pa;function Pa(e){var t=""+e,r=$a.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i
{/*!
+ * clipboard.js v2.0.11
+ * https://clipboardjs.com/
+ *
+ * Licensed MIT © Zeno Rocha
+ */(function(t,r){typeof Rt=="object"&&typeof Yr=="object"?Yr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Rt=="object"?Rt.ClipboardJS=r():t.ClipboardJS=r()})(Rt,function(){return(function(){var e={686:(function(o,n,i){"use strict";i.d(n,{default:function(){return Ui}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(D){try{return document.execCommand(D)}catch(A){return!1}}var d=function(A){var M=f()(A);return u("cut"),M},y=d;function L(D){var A=document.documentElement.getAttribute("dir")==="rtl",M=document.createElement("textarea");M.style.fontSize="12pt",M.style.border="0",M.style.padding="0",M.style.margin="0",M.style.position="absolute",M.style[A?"right":"left"]="-9999px";var F=window.pageYOffset||document.documentElement.scrollTop;return M.style.top="".concat(F,"px"),M.setAttribute("readonly",""),M.value=D,M}var X=function(A,M){var F=L(A);M.container.appendChild(F);var V=f()(F);return u("copy"),F.remove(),V},ee=function(A){var M=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},F="";return typeof A=="string"?F=X(A,M):A instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(A==null?void 0:A.type)?F=X(A.value,M):(F=f()(A),u("copy")),F},J=ee;function k(D){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?k=function(M){return typeof M}:k=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},k(D)}var ft=function(){var A=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},M=A.action,F=M===void 0?"copy":M,V=A.container,Y=A.target,$e=A.text;if(F!=="copy"&&F!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&k(Y)==="object"&&Y.nodeType===1){if(F==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(F==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if($e)return J($e,{container:V});if(Y)return F==="cut"?y(Y):J(Y,{container:V})},qe=ft;function Fe(D){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Fe=function(M){return typeof M}:Fe=function(M){return M&&typeof Symbol=="function"&&M.constructor===Symbol&&M!==Symbol.prototype?"symbol":typeof M},Fe(D)}function ki(D,A){if(!(D instanceof A))throw new TypeError("Cannot call a class as a function")}function no(D,A){for(var M=0;M0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof V.action=="function"?V.action:this.defaultAction,this.target=typeof V.target=="function"?V.target:this.defaultTarget,this.text=typeof V.text=="function"?V.text:this.defaultText,this.container=Fe(V.container)==="object"?V.container:document.body}},{key:"listenClick",value:function(V){var Y=this;this.listener=c()(V,"click",function($e){return Y.onClick($e)})}},{key:"onClick",value:function(V){var Y=V.delegateTarget||V.currentTarget,$e=this.action(Y)||"copy",Wt=qe({action:$e,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Wt?"success":"error",{action:$e,text:Wt,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(V){return vr("action",V)}},{key:"defaultTarget",value:function(V){var Y=vr("target",V);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(V){return vr("text",V)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(V){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(V,Y)}},{key:"cut",value:function(V){return y(V)}},{key:"isSupported",value:function(){var V=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof V=="string"?[V]:V,$e=!!document.queryCommandSupported;return Y.forEach(function(Wt){$e=$e&&!!document.queryCommandSupported(Wt)}),$e}}]),M})(s()),Ui=Fi}),828:(function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a}),438:(function(o,n,i){var a=i(828);function s(l,f,u,d,y){var L=c.apply(this,arguments);return l.addEventListener(u,L,y),{destroy:function(){l.removeEventListener(u,L,y)}}}function p(l,f,u,d,y){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(L){return s(L,f,u,d,y)}))}function c(l,f,u,d){return function(y){y.delegateTarget=a(y.target,f),y.delegateTarget&&d.call(l,y)}}o.exports=p}),879:(function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}}),370:(function(o,n,i){var a=i(879),s=i(438);function p(u,d,y){if(!u&&!d&&!y)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(y))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,d,y);if(a.nodeList(u))return l(u,d,y);if(a.string(u))return f(u,d,y);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,d,y){return u.addEventListener(d,y),{destroy:function(){u.removeEventListener(d,y)}}}function l(u,d,y){return Array.prototype.forEach.call(u,function(L){L.addEventListener(d,y)}),{destroy:function(){Array.prototype.forEach.call(u,function(L){L.removeEventListener(d,y)})}}}function f(u,d,y){return s(document.body,u,d,y)}o.exports=p}),817:(function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n}),279:(function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function z(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||p(d,L)})},y&&(n[d]=y(n[d])))}function p(d,y){try{c(o[d](y))}catch(L){u(i[0][3],L)}}function c(d){d.value instanceof nt?Promise.resolve(d.value.v).then(l,f):u(i[0][2],d)}function l(d){p("next",d)}function f(d){p("throw",d)}function u(d,y){d(y),i.shift(),i.length&&p(i[0][0],i[0][1])}}function uo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof he=="function"?he(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function H(e){return typeof e=="function"}function ut(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ut(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription:
+`+r.map(function(o,n){return n+1+") "+o.toString()}).join(`
+ `):"",this.name="UnsubscriptionError",this.errors=r}});function Qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Ue=(function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=he(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(L){t={error:L}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(H(l))try{l()}catch(L){i=L instanceof zt?L.errors:[L]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=he(f),d=u.next();!d.done;d=u.next()){var y=d.value;try{ho(y)}catch(L){i=i!=null?i:[],L instanceof zt?i=q(q([],z(i)),z(L.errors)):i.push(L)}}}catch(L){o={error:L}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)ho(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&Qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&Qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=(function(){var t=new e;return t.closed=!0,t})(),e})();var Tr=Ue.EMPTY;function Nt(e){return e instanceof Ue||e&&"closed"in e&&H(e.remove)&&H(e.add)&&H(e.unsubscribe)}function ho(e){H(e)?e():e.unsubscribe()}var Pe={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var dt={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Ue(function(){o.currentObservers=null,Qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new j;return r.source=this,r},t.create=function(r,o){return new To(r,o)},t})(j);var To=(function(e){oe(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t})(g);var _r=(function(e){oe(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t})(g);var _t={now:function(){return(_t.delegate||Date).now()},delegate:void 0};var At=(function(e){oe(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=_t);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t})(gt);var Lo=(function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t})(yt);var kr=new Lo(Oo);var Mo=(function(e){oe(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=vt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&o===r._scheduled&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(vt.cancelAnimationFrame(o),r._scheduled=void 0)},t})(gt);var _o=(function(e){oe(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o;r?o=r.id:(o=this._scheduled,this._scheduled=void 0);var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t})(yt);var me=new _o(Mo);var S=new j(function(e){return e.complete()});function Kt(e){return e&&H(e.schedule)}function Hr(e){return e[e.length-1]}function Xe(e){return H(Hr(e))?e.pop():void 0}function ke(e){return Kt(Hr(e))?e.pop():void 0}function Yt(e,t){return typeof Hr(e)=="number"?e.pop():t}var xt=(function(e){return e&&typeof e.length=="number"&&typeof e!="function"});function Bt(e){return H(e==null?void 0:e.then)}function Gt(e){return H(e[bt])}function Jt(e){return Symbol.asyncIterator&&H(e==null?void 0:e[Symbol.asyncIterator])}function Xt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Zi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Zt=Zi();function er(e){return H(e==null?void 0:e[Zt])}function tr(e){return fo(this,arguments,function(){var r,o,n,i;return Dt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function rr(e){return H(e==null?void 0:e.getReader)}function U(e){if(e instanceof j)return e;if(e!=null){if(Gt(e))return ea(e);if(xt(e))return ta(e);if(Bt(e))return ra(e);if(Jt(e))return Ao(e);if(er(e))return oa(e);if(rr(e))return na(e)}throw Xt(e)}function ea(e){return new j(function(t){var r=e[bt]();if(H(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function ta(e){return new j(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,Te(1),r?Ve(t):Qo(function(){return new nr}))}}function jr(e){return e<=0?function(){return S}:E(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,d=0,y=!1,L=!1,X=function(){f==null||f.unsubscribe(),f=void 0},ee=function(){X(),l=u=void 0,y=L=!1},J=function(){var k=l;ee(),k==null||k.unsubscribe()};return E(function(k,ft){d++,!L&&!y&&X();var qe=u=u!=null?u:r();ft.add(function(){d--,d===0&&!L&&!y&&(f=Ur(J,p))}),qe.subscribe(ft),!l&&d>0&&(l=new at({next:function(Fe){return qe.next(Fe)},error:function(Fe){L=!0,X(),f=Ur(ee,n,Fe),qe.error(Fe)},complete:function(){y=!0,X(),f=Ur(ee,a),qe.complete()}}),U(k).subscribe(l))})(c)}}function Ur(e,t){for(var r=[],o=2;oe.next(document)),e}function P(e,t=document){return Array.from(t.querySelectorAll(e))}function R(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Ie(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var wa=O(h(document.body,"focusin"),h(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Ie()||document.body),G(1));function et(e){return wa.pipe(m(t=>e.contains(t)),K())}function Ht(e,t){return C(()=>O(h(e,"mouseenter").pipe(m(()=>!0)),h(e,"mouseleave").pipe(m(()=>!1))).pipe(t?kt(r=>Le(+!r*t)):le,Q(e.matches(":hover"))))}function Jo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Jo(e,r)}function x(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Jo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=x("script",{src:e});return C(()=>(document.head.appendChild(t),O(h(t,"load"),h(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),_(()=>document.head.removeChild(t)),Te(1))))}var Xo=new g,Ta=C(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Xo.next(t)))),v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return Ta.pipe(w(r=>r.observe(t)),v(r=>Xo.pipe(b(o=>o.target===t),_(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function Tt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Zo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function De(e){return{x:e.offsetLeft,y:e.offsetTop}}function en(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function tn(e){return O(h(window,"load"),h(window,"resize")).pipe(Me(0,me),m(()=>De(e)),Q(De(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function ze(e){return O(h(e,"scroll"),h(window,"scroll"),h(window,"resize")).pipe(Me(0,me),m(()=>pr(e)),Q(pr(e)))}var rn=new g,Sa=C(()=>I(new IntersectionObserver(e=>{for(let t of e)rn.next(t)},{threshold:0}))).pipe(v(e=>O(Ye,I(e)).pipe(_(()=>e.disconnect()))),G(1));function tt(e){return Sa.pipe(w(t=>t.observe(e)),v(t=>rn.pipe(b(({target:r})=>r===e),_(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function on(e,t=16){return ze(e).pipe(m(({y:r})=>{let o=ce(e),n=Tt(e);return r>=n.height-o.height-t}),K())}var lr={drawer:R("[data-md-toggle=drawer]"),search:R("[data-md-toggle=search]")};function nn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function Ne(e){let t=lr[e];return h(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function Oa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function La(){return O(h(window,"compositionstart").pipe(m(()=>!0)),h(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function an(){let e=h(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:nn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Ie();if(typeof o!="undefined")return!Oa(o,r)}return!0}),pe());return La().pipe(v(t=>t?S:e))}function ye(){return new URL(location.href)}function lt(e,t=!1){if(B("navigation.instant")&&!t){let r=x("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function sn(){return new g}function cn(){return location.hash.slice(1)}function pn(e){let t=x("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Ma(e){return O(h(window,"hashchange"),e).pipe(m(cn),Q(cn()),b(t=>t.length>0),G(1))}function ln(e){return Ma(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function $t(e){let t=matchMedia(e);return ir(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function mn(){let e=matchMedia("print");return O(h(window,"beforeprint").pipe(m(()=>!0)),h(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function zr(e,t){return e.pipe(v(r=>r?t():S))}function Nr(e,t){return new j(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function je(e,t){return Nr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),G(1))}function fn(e,t){let r=new DOMParser;return Nr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),G(1))}function un(e,t){let r=new DOMParser;return Nr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),G(1))}function dn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function hn(){return O(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(m(dn),Q(dn()))}function bn(){return{width:innerWidth,height:innerHeight}}function vn(){return h(window,"resize",{passive:!0}).pipe(m(bn),Q(bn()))}function gn(){return N([hn(),vn()]).pipe(m(([e,t])=>({offset:e,size:t})),G(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(te("size")),n=N([o,r]).pipe(m(()=>De(e)));return N([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function _a(e){return h(e,"message",t=>t.data)}function Aa(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function yn(e,t=new Worker(e)){let r=_a(t),o=Aa(t),n=new g;n.subscribe(o);let i=o.pipe(Z(),ie(!0));return n.pipe(Z(),Re(r.pipe(W(i))),pe())}var Ca=R("#__config"),St=JSON.parse(Ca.textContent);St.base=`${new URL(St.base,ye())}`;function xe(){return St}function B(e){return St.features.includes(e)}function Ee(e,t){return typeof t!="undefined"?St.translations[e].replace("#",t.toString()):St.translations[e]}function Se(e,t=document){return R(`[data-md-component=${e}]`,t)}function ae(e,t=document){return P(`[data-md-component=${e}]`,t)}function ka(e){let t=R(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(m(()=>R(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function xn(e){if(!B("announce.dismiss")||!e.childElementCount)return S;if(!e.hidden){let t=R(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),ka(e).pipe(w(r=>t.next(r)),_(()=>t.complete()),m(r=>$({ref:e},r)))})}function Ha(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function En(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Ha(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))}function Pt(e,t){return t==="inline"?x("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"})):x("div",{class:"md-tooltip",id:e,role:"tooltip"},x("div",{class:"md-tooltip__inner md-typeset"}))}function wn(...e){return x("div",{class:"md-tooltip2",role:"tooltip"},x("div",{class:"md-tooltip2__inner md-typeset"},e))}function Tn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("a",{href:r,class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}else return x("aside",{class:"md-annotation",tabIndex:0},Pt(t),x("span",{class:"md-annotation__index",tabIndex:-1},x("span",{"data-md-annotation-id":e})))}function Sn(e){return x("button",{class:"md-clipboard md-icon",title:Ee("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}var Ln=Lt(qr());function Qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,x("del",null,(0,Ln.default)(c))," "],[]).slice(0,-1),i=xe(),a=new URL(e.location,i.base);B("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=xe();return x("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},x("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&x("div",{class:"md-search-result__icon md-icon"}),r>0&&x("h1",null,e.title),r<=0&&x("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&x("nav",{class:"md-tags"},e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return x("span",{class:`md-tag ${c}`},p)})),o>0&&n.length>0&&x("p",{class:"md-search-result__terms"},Ee("search.result.term.missing"),": ",...n)))}function Mn(e){let t=e[0].score,r=[...e],o=xe(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreQr(l,1)),...p.length?[x("details",{class:"md-search-result__more"},x("summary",{tabIndex:-1},x("div",null,p.length>0&&p.length===1?Ee("search.result.more.one"):Ee("search.result.more.other",p.length))),...p.map(l=>Qr(l,1)))]:[]];return x("li",{class:"md-search-result__item"},c)}function _n(e){return x("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>x("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Kr(e){let t=`tabbed-control tabbed-control--${e}`;return x("div",{class:t,hidden:!0},x("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function An(e){return x("div",{class:"md-typeset__scrollwrap"},x("div",{class:"md-typeset__table"},e))}function Ra(e){var o;let t=xe(),r=new URL(`../${e.version}/`,t.base);return x("li",{class:"md-version__item"},x("a",{href:`${r}`,class:"md-version__link"},e.title,((o=t.version)==null?void 0:o.alias)&&e.aliases.length>0&&x("span",{class:"md-version__alias"},e.aliases[0])))}function Cn(e,t){var o;let r=xe();return e=e.filter(n=>{var i;return!((i=n.properties)!=null&&i.hidden)}),x("div",{class:"md-version"},x("button",{class:"md-version__current","aria-label":Ee("select.version")},t.title,((o=r.version)==null?void 0:o.alias)&&t.aliases.length>0&&x("span",{class:"md-version__alias"},t.aliases[0])),x("ul",{class:"md-version__list"},e.map(Ra)))}var Ia=0;function ja(e){let t=N([et(e),Ht(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Zo(e)).pipe(ne(ze),pt(1),He(t),m(()=>en(e)));return t.pipe(Ae(o=>o),v(()=>N([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function Fa(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ia++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(Z(),ie(!1)).subscribe(a);let s=a.pipe(kt(c=>Le(+!c*250,kr)),K(),v(c=>c?r:S),w(c=>c.id=n),pe());N([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>Ht(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),re(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),d=u.width/2;if(l.role==="tooltip")return{x:d,y:8+u.height};if(u.y>=f.height/2){let{height:y}=ce(l);return{x:d,y:-16-y}}else return{x:d,y:16+u.height}}));return N([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),re(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(R(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),ve(me),re(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),N([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ja(e).pipe(w(c=>i.next(c)),_(()=>i.complete()),m(c=>$({ref:e},c)))})}function mt(e,{viewport$:t},r=document.body){return Fa(e,{content$:new j(o=>{let n=e.title,i=wn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Ua(e,t){let r=C(()=>N([tn(e),ze(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),Te(+!o||1/0))))}function kn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(W(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),O(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Me(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(W(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),h(n,"mousedown").pipe(W(a),re(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Ie())==null||c.blur()}}),r.pipe(W(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Ua(e,t).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function Wa(e){return e.tagName==="CODE"?P(".c, .c1, .cm",e):[e]}function Va(e){let t=[];for(let r of Wa(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function Hn(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Va(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,Tn(p,i)),s.replaceWith(a.get(p)))}return a.size===0?S:C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=[];for(let[l,f]of a)c.push([R(".md-typeset",f),R(`:scope > li:nth-child(${l})`,e)]);return o.pipe(W(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?Hn(f,u):Hn(u,f)}),O(...[...a].map(([,l])=>kn(l,t,{target$:r}))).pipe(_(()=>s.complete()),pe())})}function $n(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return $n(t)}}function Pn(e,t){return C(()=>{let r=$n(e);return typeof r!="undefined"?fr(r,e,t):S})}var Rn=Lt(Br());var Da=0;function In(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return In(t)}}function za(e){return ge(e).pipe(m(({width:t})=>({scrollable:Tt(e).width>t})),te("scrollable"))}function jn(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(jr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Rn.default.isSupported()&&(e.closest(".copy")||B("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Da++}`;let l=Sn(c.id);c.insertBefore(l,e),B("content.tooltips")&&a.push(mt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=In(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||B("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(W(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:S)))}}return P(":scope > span[id]",e).length&&e.classList.add("md-code__content"),za(e).pipe(w(c=>n.next(c)),_(()=>n.complete()),m(c=>$({ref:e},c)),Re(...a))});return B("content.lazy")?tt(e).pipe(b(n=>n),Te(1),v(()=>o)):o}function Na(e,{target$:t,print$:r}){let o=!0;return O(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),w(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Fn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Na(e,t).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}var Un=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.flowchartTitleText{fill:var(--md-mermaid-label-fg-color)}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel p,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel p{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color)}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}.classDiagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs marker.marker.composition.class path,defs marker.marker.dependency.class path,defs marker.marker.extension.class path{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs marker.marker.aggregation.class path{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}.statediagramTitleText{fill:var(--md-mermaid-label-fg-color)}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}a .nodeLabel{text-decoration:underline}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}[id^=entity] path,[id^=entity] rect{fill:var(--md-default-bg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs .marker.oneOrMore.er *,defs .marker.onlyOne.er *,defs .marker.zeroOrMore.er *,defs .marker.zeroOrOne.er *{stroke:var(--md-mermaid-edge-color)!important}text:not([class]):last-child{fill:var(--md-mermaid-label-fg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Gr,Qa=0;function Ka(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@11/dist/mermaid.min.js"):I(void 0)}function Wn(e){return e.classList.remove("mermaid"),Gr||(Gr=Ka().pipe(w(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Un,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),G(1))),Gr.subscribe(()=>co(null,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Qa++}`,r=x("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Gr.pipe(m(()=>({ref:e})))}var Vn=x("table");function Dn(e){return e.replaceWith(Vn),Vn.replaceWith(An(e)),I({ref:e})}function Ya(e){let t=e.find(r=>r.checked)||e[0];return O(...e.map(r=>h(r,"change").pipe(m(()=>R(`label[for="${r.id}"]`))))).pipe(Q(R(`label[for="${t.id}"]`)),m(r=>({active:r})))}function zn(e,{viewport$:t,target$:r}){let o=R(".tabbed-labels",e),n=P(":scope > input",e),i=Kr("prev");e.append(i);let a=Kr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(Z(),ie(!0));N([s,ge(e),tt(e)]).pipe(W(p),Me(1,me)).subscribe({next([{active:c},l]){let f=De(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let d=pr(o);(f.xd.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),N([ze(o),ge(o)]).pipe(W(p)).subscribe(([c,l])=>{let f=Tt(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),O(h(i,"click").pipe(m(()=>-1)),h(a,"click").pipe(m(()=>1))).pipe(W(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(W(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=R(`label[for="${c.id}"]`);l.replaceChildren(x("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),h(l.firstElementChild,"click").pipe(W(p),b(f=>!(f.metaKey||f.ctrlKey)),w(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return B("content.tabs.link")&&s.pipe(Ce(1),re(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let y of P("[data-tabs]"))for(let L of P(":scope > input",y)){let X=R(`label[for="${L.id}"]`);if(X!==c&&X.innerText.trim()===f){X.setAttribute("data-md-switching",""),L.click();break}}window.scrollTo({top:e.offsetTop-u});let d=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...d])])}}),s.pipe(W(p)).subscribe(()=>{for(let c of P("audio, video",e))c.offsetWidth&&c.autoplay?c.play().catch(()=>{}):c.pause()}),Ya(n).pipe(w(c=>s.next(c)),_(()=>s.complete()),m(c=>$({ref:e},c)))}).pipe(Ke(se))}function Nn(e,{viewport$:t,target$:r,print$:o}){return O(...P(".annotate:not(.highlight)",e).map(n=>Pn(n,{target$:r,print$:o})),...P("pre:not(.mermaid) > code",e).map(n=>jn(n,{target$:r,print$:o})),...P("pre.mermaid",e).map(n=>Wn(n)),...P("table:not([class])",e).map(n=>Dn(n)),...P("details",e).map(n=>Fn(n,{target$:r,print$:o})),...P("[data-tabs]",e).map(n=>zn(n,{viewport$:t,target$:r})),...P("[title]",e).filter(()=>B("content.tooltips")).map(n=>mt(n,{viewport$:t})))}function Ba(e,{alert$:t}){return t.pipe(v(r=>O(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function qn(e,t){let r=R(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),Ba(e,t).pipe(w(n=>o.next(n)),_(()=>o.complete()),m(n=>$({ref:e},n)))})}var Ga=0;function Ja(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?ze(o):I({x:0,y:0}),i=O(et(t),Ht(t)).pipe(K());return N([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=De(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Qn(e){let t=e.title;if(!t.length)return S;let r=`__tooltip_${Ga++}`,o=Pt(r,"inline"),n=R(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),O(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Me(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(pt(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Ja(o,e).pipe(w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))}).pipe(Ke(se))}function Xa({viewport$:e}){if(!B("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Be(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=Ne("search");return N([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Kn(e,t){return C(()=>N([ge(e),Xa(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),G(1))}function Yn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(Z(),ie(!0));o.pipe(te("active"),He(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue(P("[title]",e)).pipe(b(()=>B("content.tooltips")),ne(a=>Qn(a)));return r.subscribe(o),t.pipe(W(n),m(a=>$({ref:e},a)),Re(i.pipe(W(n))))})}function Za(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:n>0&&o>=n}}),te("active"))}function Bn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?S:Za(o,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))})}function Gn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),te("bottom"))));return N([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function es(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(ne(o=>h(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),G(1))}function Jn(e){let t=P("input",e),r=x("meta",{name:"theme-color"});document.head.appendChild(r);let o=x("meta",{name:"color-scheme"});document.head.appendChild(o);let n=$t("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),re(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(ve(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),es(t).pipe(W(n.pipe(Ce(1))),ct(),w(a=>i.next(a)),_(()=>i.complete()),m(a=>$({ref:e},a)))})}function Xn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(w(o=>r.next({value:o})),_(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Jr=Lt(Br());function ts(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Zn({alert$:e}){Jr.default.isSupported()&&new j(t=>{new Jr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||ts(R(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(w(t=>{t.trigger.focus()}),m(()=>Ee("clipboard.copied"))).subscribe(e)}function ei(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function rs(e,t){let r=new Map;for(let o of P("url",e)){let n=R("loc",o),i=[ei(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of P("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(ei(new URL(s),t))}}return r}function ur(e){return un(new URL("sitemap.xml",e)).pipe(m(t=>rs(t,new URL(e))),de(()=>I(new Map)))}function os(e,t){if(!(e.target instanceof Element))return S;let r=e.target.closest("a");if(r===null)return S;if(r.target||e.metaKey||e.ctrlKey)return S;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):S}function ti(e){let t=new Map;for(let r of P(":scope > *",e.head))t.set(r.outerHTML,r);return t}function ri(e){for(let t of P("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function ns(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...B("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=ti(document);for(let[o,n]of ti(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return We(P("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new j(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),S}),Z(),ie(document))}function oi({location$:e,viewport$:t,progress$:r}){let o=xe();if(location.protocol==="file:")return S;let n=ur(o.base);I(document).subscribe(ri);let i=h(document.body,"click").pipe(He(n),v(([p,c])=>os(p,c)),pe()),a=h(window,"popstate").pipe(m(ye),pe());i.pipe(re(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),O(i,a).subscribe(e);let s=e.pipe(te("pathname"),v(p=>fn(p,{progress$:r}).pipe(de(()=>(lt(p,!0),S)))),v(ri),v(ns),pe());return O(s.pipe(re(e,(p,c)=>c)),s.pipe(v(()=>e),te("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),w(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",pn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(te("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ni=Lt(qr());function ii(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a} `;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").replace(/&/g,"&").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ni.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function It(e){return e.type===1}function dr(e){return e.type===3}function ai(e,t){let r=yn(e);return O(I(location.protocol!=="file:"),Ne("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:B("search.suggest")}}})),r}function si(e){var l;let{selectedVersionSitemap:t,selectedVersionBaseURL:r,currentLocation:o,currentBaseURL:n}=e,i=(l=Xr(n))==null?void 0:l.pathname;if(i===void 0)return;let a=ss(o.pathname,i);if(a===void 0)return;let s=ps(t.keys());if(!t.has(s))return;let p=Xr(a,s);if(!p||!t.has(p.href))return;let c=Xr(a,r);if(c)return c.hash=o.hash,c.search=o.search,c}function Xr(e,t){try{return new URL(e,t)}catch(r){return}}function ss(e,t){if(e.startsWith(t))return e.slice(t.length)}function cs(e,t){let r=Math.min(e.length,t.length),o;for(o=0;oS)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>h(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),re(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?S:(i.preventDefault(),I(new URL(p)))}}return S}),v(i=>ur(i).pipe(m(a=>{var s;return(s=si({selectedVersionSitemap:a,selectedVersionBaseURL:i,currentLocation:ye(),currentBaseURL:t.base}))!=null?s:i})))))).subscribe(n=>lt(n,!0)),N([r,o]).subscribe(([n,i])=>{R(".md-header__topic").appendChild(Cn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var s;let i=new URL(t.base),a=__md_get("__outdated",sessionStorage,i);if(a===null){a=!0;let p=((s=t.version)==null?void 0:s.default)||"latest";Array.isArray(p)||(p=[p]);e:for(let c of p)for(let l of n.aliases.concat(n.version))if(new RegExp(c,"i").test(l)){a=!1;break e}__md_set("__outdated",a,sessionStorage,i)}if(a)for(let p of ae("outdated"))p.hidden=!1})}function ls(e,{worker$:t}){let{searchParams:r}=ye();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),Ne("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=ye();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=O(t.pipe(Ae(It)),h(e,"keyup"),o).pipe(m(()=>e.value),K());return N([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),G(1))}function pi(e,{worker$:t}){let r=new g,o=r.pipe(Z(),ie(!0));N([t.pipe(Ae(It)),r],(i,a)=>a).pipe(te("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(te("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),h(e.form,"reset").pipe(W(o)).subscribe(()=>e.focus());let n=R("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ls(e,{worker$:t}).pipe(w(i=>r.next(i)),_(()=>r.complete()),m(i=>$({ref:e},i)),G(1))}function li(e,{worker$:t,query$:r}){let o=new g,n=on(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=R(":scope > :first-child",e),s=R(":scope > :last-child",e);Ne("search").subscribe(l=>{s.setAttribute("role",l?"list":"presentation"),s.hidden=!l}),o.pipe(re(r),Wr(t.pipe(Ae(It)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?Ee("search.result.none"):Ee("search.result.placeholder");break;case 1:a.textContent=Ee("search.result.one");break;default:let u=sr(l.length);a.textContent=Ee("search.result.other",u)}});let p=o.pipe(w(()=>s.innerHTML=""),v(({items:l})=>O(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Be(4),Dr(n),v(([f])=>f)))),m(Mn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(ne(l=>{let f=fe("details",l);return typeof f=="undefined"?S:h(f,"toggle").pipe(W(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(w(l=>o.next(l)),_(()=>o.complete()),m(l=>$({ref:e},l)))}function ms(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=ye();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function mi(e,t){let r=new g,o=r.pipe(Z(),ie(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(W(o)).subscribe(n=>n.preventDefault()),ms(e,t).pipe(w(n=>r.next(n)),_(()=>r.complete()),m(n=>$({ref:e},n)))}function fi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=O(h(n,"keydown"),h(n,"focus")).pipe(ve(se),m(()=>n.value),K());return o.pipe(He(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(w(s=>o.next(s)),_(()=>o.complete()),m(()=>({ref:e})))}function ui(e,{index$:t,keyboard$:r}){let o=xe();try{let n=ai(o.search,t),i=Se("search-query",e),a=Se("search-result",e);h(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Ie();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of P(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,d])=>d-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...P(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Ie()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=pi(i,{worker$:n});return O(s,li(a,{worker$:n,query$:s})).pipe(Re(...ae("search-share",e).map(p=>mi(p,{query$:s})),...ae("search-suggest",e).map(p=>fi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ye}}function di(e,{index$:t,location$:r}){return N([t,r.pipe(Q(ye()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>ii(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=x("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function fs(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return N([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Zr(e,o){var n=o,{header$:t}=n,r=so(n,["header$"]);let i=R(".md-sidebar__scrollwrap",e),{y:a}=De(i);return C(()=>{let s=new g,p=s.pipe(Z(),ie(!0)),c=s.pipe(Me(0,me));return c.pipe(re(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of P(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2})}}}),ue(P("label[tabindex]",e)).pipe(ne(l=>h(l,"click").pipe(ve(se),m(()=>l),W(p)))).subscribe(l=>{let f=R(`[id="${l.htmlFor}"]`);R(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),fs(e,r).pipe(w(l=>s.next(l)),_(()=>s.complete()),m(l=>$({ref:e},l)))})}function hi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return st(je(`${r}/releases/latest`).pipe(de(()=>S),m(o=>({version:o.tag_name})),Ve({})),je(r).pipe(de(()=>S),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Ve({}))).pipe(m(([o,n])=>$($({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return je(r).pipe(m(o=>({repositories:o.public_repos})),Ve({}))}}function bi(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return st(je(`${r}/releases/permalink/latest`).pipe(de(()=>S),m(({tag_name:o})=>({version:o})),Ve({})),je(r).pipe(de(()=>S),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Ve({}))).pipe(m(([o,n])=>$($({},o),n)))}function vi(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return hi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return bi(r,o)}return S}var us;function ds(e){return us||(us=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return S}return vi(e.href).pipe(w(o=>__md_set("__source",o,sessionStorage)))}).pipe(de(()=>S),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),G(1)))}function gi(e){let t=R(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(_n(o)),t.classList.add("md-source__repository--active")}),ds(e).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function hs(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),te("hidden"))}function yi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(B("navigation.tabs.sticky")?I({hidden:!1}):hs(e,t)).pipe(w(o=>r.next(o)),_(()=>r.complete()),m(o=>$({ref:e},o)))})}function bs(e,{viewport$:t,header$:r}){let o=new Map,n=P(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(te("height"),m(({height:s})=>{let p=Se("main"),c=R(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(te("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),He(i),v(([p,c])=>t.pipe(Fr(([l,f],{offset:{y:u},size:d})=>{let y=u+d.height>=Math.floor(s.height);for(;f.length;){let[,L]=f[0];if(L-c=u&&!y)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Be(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(Z(),ie(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),B("toc.follow")){let s=O(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),He(o.pipe(ve(se))),re(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:d}=ce(f);f.scrollTo({top:u-d/2,behavior:c})}}})}return B("navigation.tracking")&&t.pipe(W(a),te("offset"),_e(250),Ce(1),W(n.pipe(Ce(1))),ct({delay:250}),re(i)).subscribe(([,{prev:s}])=>{let p=ye(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),bs(e,{viewport$:t,header$:r}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))})}function vs(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Be(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return N([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),W(o.pipe(Ce(1))),ie(!0),ct({delay:250}),m(a=>({hidden:a})))}function Ei(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(Z(),ie(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(W(a),te("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),h(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),vs(e,{viewport$:t,main$:o,target$:n}).pipe(w(s=>i.next(s)),_(()=>i.complete()),m(s=>$({ref:e},s)))}function wi({document$:e,viewport$:t}){e.pipe(v(()=>P(".md-ellipsis")),ne(r=>tt(r).pipe(W(e.pipe(Ce(1))),b(o=>o),m(()=>r),Te(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,B("content.tooltips")?mt(n,{viewport$:t}).pipe(W(e.pipe(Ce(1))),_(()=>n.removeAttribute("title"))):S})).subscribe(),B("content.tooltips")&&e.pipe(v(()=>P(".md-status")),ne(r=>mt(r,{viewport$:t}))).subscribe()}function Ti({document$:e,tablet$:t}){e.pipe(v(()=>P(".md-toggle--indeterminate")),w(r=>{r.indeterminate=!0,r.checked=!1}),ne(r=>h(r,"change").pipe(Vr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),re(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function gs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Si({document$:e}){e.pipe(v(()=>P("[data-md-scrollfix]")),w(t=>t.removeAttribute("data-md-scrollfix")),b(gs),ne(t=>h(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Oi({viewport$:e,tablet$:t}){N([Ne("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),re(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function ys(){return location.protocol==="file:"?wt(`${new URL("search/search_index.js",eo.base)}`).pipe(m(()=>__index),G(1)):je(new URL("search/search_index.json",eo.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Go(),Ft=sn(),Ot=ln(Ft),to=an(),Oe=gn(),hr=$t("(min-width: 60em)"),Mi=$t("(min-width: 76.25em)"),_i=mn(),eo=xe(),Ai=document.forms.namedItem("search")?ys():Ye,ro=new g;Zn({alert$:ro});var oo=new g;B("navigation.instant")&&oi({location$:Ft,viewport$:Oe,progress$:oo}).subscribe(ot);var Li;((Li=eo.version)==null?void 0:Li.provider)==="mike"&&ci({document$:ot});O(Ft,Ot).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});to.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&<(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&<(r);break;case"Enter":let o=Ie();o instanceof HTMLLabelElement&&o.click()}});wi({viewport$:Oe,document$:ot});Ti({document$:ot,tablet$:hr});Si({document$:ot});Oi({viewport$:Oe,tablet$:hr});var rt=Kn(Se("header"),{viewport$:Oe}),jt=ot.pipe(m(()=>Se("main")),v(e=>Gn(e,{viewport$:Oe,header$:rt})),G(1)),xs=O(...ae("consent").map(e=>En(e,{target$:Ot})),...ae("dialog").map(e=>qn(e,{alert$:ro})),...ae("palette").map(e=>Jn(e)),...ae("progress").map(e=>Xn(e,{progress$:oo})),...ae("search").map(e=>ui(e,{index$:Ai,keyboard$:to})),...ae("source").map(e=>gi(e))),Es=C(()=>O(...ae("announce").map(e=>xn(e)),...ae("content").map(e=>Nn(e,{viewport$:Oe,target$:Ot,print$:_i})),...ae("content").map(e=>B("search.highlight")?di(e,{index$:Ai,location$:Ft}):S),...ae("header").map(e=>Yn(e,{viewport$:Oe,header$:rt,main$:jt})),...ae("header-title").map(e=>Bn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?zr(Mi,()=>Zr(e,{viewport$:Oe,header$:rt,main$:jt})):zr(hr,()=>Zr(e,{viewport$:Oe,header$:rt,main$:jt}))),...ae("tabs").map(e=>yi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>xi(e,{viewport$:Oe,header$:rt,main$:jt,target$:Ot})),...ae("top").map(e=>Ei(e,{viewport$:Oe,header$:rt,main$:jt,target$:Ot})))),Ci=ot.pipe(v(()=>Es),Re(xs),G(1));Ci.subscribe();window.document$=ot;window.location$=Ft;window.target$=Ot;window.keyboard$=to;window.viewport$=Oe;window.tablet$=hr;window.screen$=Mi;window.print$=_i;window.alert$=ro;window.progress$=oo;window.component$=Ci;})();
+//# sourceMappingURL=bundle.f55a23d4.min.js.map
+
diff --git a/mail-intake/wiki/assets/javascripts/bundle.f55a23d4.min.js.map b/mail-intake/wiki/assets/javascripts/bundle.f55a23d4.min.js.map
new file mode 100644
index 0000000..e3de73f
--- /dev/null
+++ b/mail-intake/wiki/assets/javascripts/bundle.f55a23d4.min.js.map
@@ -0,0 +1,7 @@
+{
+ "version": 3,
+ "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/escape-html/index.js", "node_modules/clipboard/dist/clipboard.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/tslib/tslib.es6.mjs", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/findurl/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"],
+ "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*\n * Copyright (c) 2016-2025 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 60em)\")\nconst screen$ = watchMedia(\"(min-width: 76.25em)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/******************************************************************************\nCopyright (c) Microsoft Corporation.\n\nPermission to use, copy, modify, and/or distribute this software for any\npurpose with or without fee is hereby granted.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\nPERFORMANCE OF THIS SOFTWARE.\n***************************************************************************** */\n/* global Reflect, Promise, SuppressedError, Symbol, Iterator */\n\nvar extendStatics = function(d, b) {\n extendStatics = Object.setPrototypeOf ||\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\n return extendStatics(d, b);\n};\n\nexport function __extends(d, b) {\n if (typeof b !== \"function\" && b !== null)\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\n extendStatics(d, b);\n function __() { this.constructor = d; }\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\n}\n\nexport var __assign = function() {\n __assign = Object.assign || function __assign(t) {\n for (var s, i = 1, n = arguments.length; i < n; i++) {\n s = arguments[i];\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\n }\n return t;\n }\n return __assign.apply(this, arguments);\n}\n\nexport function __rest(s, e) {\n var t = {};\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\n t[p] = s[p];\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\n t[p[i]] = s[p[i]];\n }\n return t;\n}\n\nexport function __decorate(decorators, target, key, desc) {\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\n return c > 3 && r && Object.defineProperty(target, key, r), r;\n}\n\nexport function __param(paramIndex, decorator) {\n return function (target, key) { decorator(target, key, paramIndex); }\n}\n\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\n var _, done = false;\n for (var i = decorators.length - 1; i >= 0; i--) {\n var context = {};\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\n if (kind === \"accessor\") {\n if (result === void 0) continue;\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\n if (_ = accept(result.get)) descriptor.get = _;\n if (_ = accept(result.set)) descriptor.set = _;\n if (_ = accept(result.init)) initializers.unshift(_);\n }\n else if (_ = accept(result)) {\n if (kind === \"field\") initializers.unshift(_);\n else descriptor[key] = _;\n }\n }\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\n done = true;\n};\n\nexport function __runInitializers(thisArg, initializers, value) {\n var useValue = arguments.length > 2;\n for (var i = 0; i < initializers.length; i++) {\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\n }\n return useValue ? value : void 0;\n};\n\nexport function __propKey(x) {\n return typeof x === \"symbol\" ? x : \"\".concat(x);\n};\n\nexport function __setFunctionName(f, name, prefix) {\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\n};\n\nexport function __metadata(metadataKey, metadataValue) {\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\n}\n\nexport function __awaiter(thisArg, _arguments, P, generator) {\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\n return new (P || (P = Promise))(function (resolve, reject) {\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\n step((generator = generator.apply(thisArg, _arguments || [])).next());\n });\n}\n\nexport function __generator(thisArg, body) {\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === \"function\" ? Iterator : Object).prototype);\n return g.next = verb(0), g[\"throw\"] = verb(1), g[\"return\"] = verb(2), typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\n function verb(n) { return function (v) { return step([n, v]); }; }\n function step(op) {\n if (f) throw new TypeError(\"Generator is already executing.\");\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\n if (y = 0, t) op = [op[0] & 2, t.value];\n switch (op[0]) {\n case 0: case 1: t = op; break;\n case 4: _.label++; return { value: op[1], done: false };\n case 5: _.label++; y = op[1]; op = [0]; continue;\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\n default:\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\n if (t[2]) _.ops.pop();\n _.trys.pop(); continue;\n }\n op = body.call(thisArg, _);\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\n }\n}\n\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n var desc = Object.getOwnPropertyDescriptor(m, k);\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\n desc = { enumerable: true, get: function() { return m[k]; } };\n }\n Object.defineProperty(o, k2, desc);\n}) : (function(o, m, k, k2) {\n if (k2 === undefined) k2 = k;\n o[k2] = m[k];\n});\n\nexport function __exportStar(m, o) {\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\n}\n\nexport function __values(o) {\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\n if (m) return m.call(o);\n if (o && typeof o.length === \"number\") return {\n next: function () {\n if (o && i >= o.length) o = void 0;\n return { value: o && o[i++], done: !o };\n }\n };\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\n}\n\nexport function __read(o, n) {\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\n if (!m) return o;\n var i = m.call(o), r, ar = [], e;\n try {\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\n }\n catch (error) { e = { error: error }; }\n finally {\n try {\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\n }\n finally { if (e) throw e.error; }\n }\n return ar;\n}\n\n/** @deprecated */\nexport function __spread() {\n for (var ar = [], i = 0; i < arguments.length; i++)\n ar = ar.concat(__read(arguments[i]));\n return ar;\n}\n\n/** @deprecated */\nexport function __spreadArrays() {\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\n r[k] = a[j];\n return r;\n}\n\nexport function __spreadArray(to, from, pack) {\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\n if (ar || !(i in from)) {\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\n ar[i] = from[i];\n }\n }\n return to.concat(ar || Array.prototype.slice.call(from));\n}\n\nexport function __await(v) {\n return this instanceof __await ? (this.v = v, this) : new __await(v);\n}\n\nexport function __asyncGenerator(thisArg, _arguments, generator) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\n return i = Object.create((typeof AsyncIterator === \"function\" ? AsyncIterator : Object).prototype), verb(\"next\"), verb(\"throw\"), verb(\"return\", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;\n function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }\n function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\n function fulfill(value) { resume(\"next\", value); }\n function reject(value) { resume(\"throw\", value); }\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\n}\n\nexport function __asyncDelegator(o) {\n var i, p;\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\n}\n\nexport function __asyncValues(o) {\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\n var m = o[Symbol.asyncIterator], i;\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\n}\n\nexport function __makeTemplateObject(cooked, raw) {\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\n return cooked;\n};\n\nvar __setModuleDefault = Object.create ? (function(o, v) {\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\n}) : function(o, v) {\n o[\"default\"] = v;\n};\n\nexport function __importStar(mod) {\n if (mod && mod.__esModule) return mod;\n var result = {};\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\n __setModuleDefault(result, mod);\n return result;\n}\n\nexport function __importDefault(mod) {\n return (mod && mod.__esModule) ? mod : { default: mod };\n}\n\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\n}\n\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\n}\n\nexport function __classPrivateFieldIn(state, receiver) {\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\n}\n\nexport function __addDisposableResource(env, value, async) {\n if (value !== null && value !== void 0) {\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\n var dispose, inner;\n if (async) {\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\n dispose = value[Symbol.asyncDispose];\n }\n if (dispose === void 0) {\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\n dispose = value[Symbol.dispose];\n if (async) inner = dispose;\n }\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\n if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };\n env.stack.push({ value: value, dispose: dispose, async: async });\n }\n else if (async) {\n env.stack.push({ async: true });\n }\n return value;\n}\n\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\n var e = new Error(message);\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\n};\n\nexport function __disposeResources(env) {\n function fail(e) {\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\n env.hasError = true;\n }\n var r, s = 0;\n function next() {\n while (r = env.stack.pop()) {\n try {\n if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);\n if (r.dispose) {\n var result = r.dispose.call(r.value);\n if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\n }\n else s |= 1;\n }\n catch (e) {\n fail(e);\n }\n }\n if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();\n if (env.hasError) throw env.error;\n }\n return next();\n}\n\nexport default {\n __extends,\n __assign,\n __rest,\n __decorate,\n __param,\n __metadata,\n __awaiter,\n __generator,\n __createBinding,\n __exportStar,\n __values,\n __read,\n __spread,\n __spreadArrays,\n __spreadArray,\n __await,\n __asyncGenerator,\n __asyncDelegator,\n __asyncValues,\n __makeTemplateObject,\n __importStar,\n __importDefault,\n __classPrivateFieldGet,\n __classPrivateFieldSet,\n __classPrivateFieldIn,\n __addDisposableResource,\n __disposeResources,\n};\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n */\nexport class Subscription implements SubscriptionLike {\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param value The `next` value.\n */\n next(value: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param err The `error` exception.\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as ((value: T) => void) | undefined,\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent.\n * @param subscriber The stopped subscriber.\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @param subscribe The function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @param subscribe the subscriber function to be passed to the Observable constructor\n * @return A new observable.\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @param operator the operator defining the operation to take on the observable\n * @return A new observable with the Operator applied.\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening. \n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param observerOrNext Either an {@link Observer} with some or all callback methods,\n * or the `next` handler that is called for each value emitted from the subscribed Observable.\n * @param error A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param complete A handler for a terminal event resulting from successful completion.\n * @return A subscription reference to the registered handlers.\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next A handler for each value emitted by the observable.\n * @return A promise that either resolves on observable completion or\n * rejects with the handled error.\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @return This instance of the observable.\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction