This commit is contained in:
@@ -1182,24 +1182,26 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Mail ingestion orchestration for Mail Intake.</p>
|
||||
<hr />
|
||||
<h4 id="mail_intake.ingestion--summary">Summary</h4>
|
||||
<h3 id="mail_intake.ingestion--summary">Summary</h3>
|
||||
<p>Mail ingestion orchestration for Mail Intake.</p>
|
||||
<p>This package contains <strong>high-level ingestion components</strong> responsible for
|
||||
coordinating mail retrieval, parsing, normalization, and model construction.</p>
|
||||
<p>It represents the <strong>top of the ingestion pipeline</strong> and is intended to be the
|
||||
primary interaction surface for library consumers.</p>
|
||||
<p>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</p>
|
||||
<p>Components in this package:</p>
|
||||
<ul>
|
||||
<li>Are provider-agnostic.</li>
|
||||
<li>Depend only on adapter and parser contracts.</li>
|
||||
<li>Contain no provider-specific API logic.</li>
|
||||
<li>Expose read-only ingestion workflows.</li>
|
||||
</ul>
|
||||
<p>Consumers are expected to construct a mail adapter and pass it to the
|
||||
ingestion layer to begin processing messages and threads.</p>
|
||||
<hr />
|
||||
<h4 id="mail_intake.ingestion--public-api">Public API</h4>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>MailIntakeReader
|
||||
</code></pre></div></td></tr></table></div>
|
||||
<h3 id="mail_intake.ingestion--public-api">Public API</h3>
|
||||
<ul>
|
||||
<li><code>MailIntakeReader</code></li>
|
||||
</ul>
|
||||
<hr />
|
||||
|
||||
|
||||
@@ -1235,11 +1237,23 @@ ingestion layer to begin processing messages and threads.</p>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Responsibilities:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- 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
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span>
|
||||
<span class="normal">5</span>
|
||||
<span class="normal">6</span>
|
||||
<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code>- 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.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
<p><strong>Constraints:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- This class is intentionally: Provider-agnostic, stateless beyond iteration scope, read-only
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- This class is intentionally: Provider-agnostic, stateless beyond
|
||||
iteration scope, read-only.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
<p>Initialize the mail reader.</p>
|
||||
@@ -1259,7 +1273,7 @@ ingestion layer to begin processing messages and threads.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>adapter</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.adapters.base.MailIntakeAdapter" href="../mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter">MailIntakeAdapter</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.adapters.base.MailIntakeAdapter" href="../adapters/base/#mail_intake.adapters.base.MailIntakeAdapter">MailIntakeAdapter</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1365,7 +1379,7 @@ ingestion layer to begin processing messages and threads.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.exceptions.MailIntakeParsingError" href="../mail_intake/exceptions/#mail_intake.exceptions.MailIntakeParsingError">MailIntakeParsingError</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.exceptions.MailIntakeParsingError" href="../exceptions/#mail_intake.exceptions.MailIntakeParsingError">MailIntakeParsingError</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1459,7 +1473,7 @@ ingestion layer to begin processing messages and threads.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.exceptions.MailIntakeParsingError" href="../mail_intake/exceptions/#mail_intake.exceptions.MailIntakeParsingError">MailIntakeParsingError</a></code>
|
||||
<code>`MailIntakeParsingError`</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1474,7 +1488,9 @@ ingestion layer to begin processing messages and threads.</p>
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Messages are grouped by `thread_id` and yielded as complete thread objects containing all associated messages
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Messages are grouped by `thread_id` and yielded as complete
|
||||
thread objects containing all associated messages.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
@@ -1320,16 +1320,17 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>High-level mail ingestion orchestration for Mail Intake.</p>
|
||||
<hr />
|
||||
<h4 id="mail_intake.ingestion.reader--summary">Summary</h4>
|
||||
<h3 id="mail_intake.ingestion.reader--summary">Summary</h3>
|
||||
<p>High-level mail ingestion orchestration for Mail Intake.</p>
|
||||
<p>This module provides the primary, provider-agnostic entry point for
|
||||
reading and processing mail data.</p>
|
||||
<p>It coordinates:
|
||||
- Mail adapter access
|
||||
- Message and thread iteration
|
||||
- Header and body parsing
|
||||
- Normalization and model construction</p>
|
||||
<p>It coordinates:</p>
|
||||
<ul>
|
||||
<li>Mail adapter access.</li>
|
||||
<li>Message and thread iteration.</li>
|
||||
<li>Header and body parsing.</li>
|
||||
<li>Normalization and model construction.</li>
|
||||
</ul>
|
||||
<p>No provider-specific logic or API semantics are permitted in this layer.</p>
|
||||
|
||||
|
||||
@@ -1365,11 +1366,23 @@ reading and processing mail data.</p>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Responsibilities:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- 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
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span>
|
||||
<span class="normal">5</span>
|
||||
<span class="normal">6</span>
|
||||
<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code>- 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.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
<p><strong>Constraints:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- This class is intentionally: Provider-agnostic, stateless beyond iteration scope, read-only
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- This class is intentionally: Provider-agnostic, stateless beyond
|
||||
iteration scope, read-only.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
<p>Initialize the mail reader.</p>
|
||||
@@ -1389,7 +1402,7 @@ reading and processing mail data.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>adapter</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.adapters.base.MailIntakeAdapter" href="../../mail_intake/adapters/base/#mail_intake.adapters.base.MailIntakeAdapter">MailIntakeAdapter</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.adapters.base.MailIntakeAdapter" href="../../adapters/base/#mail_intake.adapters.base.MailIntakeAdapter">MailIntakeAdapter</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1495,7 +1508,7 @@ reading and processing mail data.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.exceptions.MailIntakeParsingError" href="../../mail_intake/exceptions/#mail_intake.exceptions.MailIntakeParsingError">MailIntakeParsingError</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.exceptions.MailIntakeParsingError" href="../../exceptions/#mail_intake.exceptions.MailIntakeParsingError">MailIntakeParsingError</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1589,7 +1602,7 @@ reading and processing mail data.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.exceptions.MailIntakeParsingError" href="../../mail_intake/exceptions/#mail_intake.exceptions.MailIntakeParsingError">MailIntakeParsingError</a></code>
|
||||
<code>`MailIntakeParsingError`</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1604,7 +1617,9 @@ reading and processing mail data.</p>
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Messages are grouped by `thread_id` and yielded as complete thread objects containing all associated messages
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Messages are grouped by `thread_id` and yielded as complete
|
||||
thread objects containing all associated messages.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user