This commit is contained in:
@@ -1284,16 +1284,17 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Google authentication provider implementation for Mail Intake.</p>
|
||||
<hr />
|
||||
<h4 id="mail_intake.auth.google--summary">Summary</h4>
|
||||
<h3 id="mail_intake.auth.google--summary">Summary</h3>
|
||||
<p>Google authentication provider implementation for Mail Intake.</p>
|
||||
<p>This module provides a <strong>Google OAuth–based authentication provider</strong>
|
||||
used primarily for Gmail access.</p>
|
||||
<p>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</p>
|
||||
<p>It encapsulates all Google-specific authentication concerns, including:</p>
|
||||
<ul>
|
||||
<li>Credential loading and persistence.</li>
|
||||
<li>Token refresh handling.</li>
|
||||
<li>Interactive OAuth flow initiation.</li>
|
||||
<li>Coordination with a credential persistence layer.</li>
|
||||
</ul>
|
||||
<p>No Google authentication details should leak outside this module.</p>
|
||||
|
||||
|
||||
@@ -1321,7 +1322,7 @@ used primarily for Gmail access.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
<p class="doc doc-class-bases">
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="mail_intake.auth.base.MailIntakeAuthProvider" href="../../mail_intake/auth/base/#mail_intake.auth.base.MailIntakeAuthProvider">MailIntakeAuthProvider</a></code></p>
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="mail_intake.auth.base.MailIntakeAuthProvider" href="../base/#mail_intake.auth.base.MailIntakeAuthProvider">MailIntakeAuthProvider</a></code></p>
|
||||
|
||||
|
||||
<p>Google OAuth provider for Gmail access.</p>
|
||||
@@ -1335,13 +1336,15 @@ Google's OAuth 2.0 flow and credential management libraries.</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>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- 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
|
||||
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- 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.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
<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>- This class is synchronous by design and maintains a minimal internal state
|
||||
<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 synchronous by design and maintains a minimal
|
||||
internal state.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
<p>Initialize the Google authentication provider.</p>
|
||||
@@ -1375,7 +1378,7 @@ Google's OAuth 2.0 flow and credential management libraries.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>store</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.credentials.store.CredentialStore" href="../../mail_intake/credentials/store/#mail_intake.credentials.store.CredentialStore">CredentialStore</a>[<span title="google.oauth2.credentials.Credentials">Credentials</span>]</code>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.credentials.store.CredentialStore" href="../../credentials/store/#mail_intake.credentials.store.CredentialStore">CredentialStore</a>[<span title="google.oauth2.credentials.Credentials">Credentials</span>]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1467,7 +1470,7 @@ for use with Google API clients.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.exceptions.MailIntakeAuthError" href="../../mail_intake/exceptions/#mail_intake.exceptions.MailIntakeAuthError">MailIntakeAuthError</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="mail_intake.exceptions.MailIntakeAuthError" href="../../exceptions/#mail_intake.exceptions.MailIntakeAuthError">MailIntakeAuthError</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1486,10 +1489,10 @@ or obtained via interactive authentication.</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>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- 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
|
||||
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- 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.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user