Update documentation to include XOAUTH2

index.html

@@ -136,28 +136,29 @@ <h2 class="subtitle" id="user-documentation">User Documentation</h2>
 <div class="contents topic" id="table-of-contents">
 <p class="topic-title first">Table of Contents</p>
 <ul class="auto-toc simple">
-<li><a class="reference internal" href="#dependencies" id="id1">1&nbsp;&nbsp;&nbsp;Dependencies</a><ul class="auto-toc">
-<li><a class="reference internal" href="#the-pear-error-class" id="id2">1.1&nbsp;&nbsp;&nbsp;The <tt class="docutils literal">PEAR_Error</tt> Class</a></li>
-<li><a class="reference internal" href="#the-net-socket-package" id="id3">1.2&nbsp;&nbsp;&nbsp;The <tt class="docutils literal">Net_Socket</tt> Package</a></li>
-<li><a class="reference internal" href="#the-auth-sasl-package" id="id4">1.3&nbsp;&nbsp;&nbsp;The <tt class="docutils literal">Auth_SASL</tt> Package</a></li>
+<li><a class="reference internal" href="#dependencies" id="id2">1&nbsp;&nbsp;&nbsp;Dependencies</a><ul class="auto-toc">
+<li><a class="reference internal" href="#the-pear-error-class" id="id3">1.1&nbsp;&nbsp;&nbsp;The <tt class="docutils literal">PEAR_Error</tt> Class</a></li>
+<li><a class="reference internal" href="#the-net-socket-package" id="id4">1.2&nbsp;&nbsp;&nbsp;The <tt class="docutils literal">Net_Socket</tt> Package</a></li>
+<li><a class="reference internal" href="#the-auth-sasl-package" id="id5">1.3&nbsp;&nbsp;&nbsp;The <tt class="docutils literal">Auth_SASL</tt> Package</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#error-handling" id="id5">2&nbsp;&nbsp;&nbsp;Error Handling</a></li>
-<li><a class="reference internal" href="#smtp-authentication" id="id6">3&nbsp;&nbsp;&nbsp;SMTP Authentication</a><ul class="auto-toc">
-<li><a class="reference internal" href="#gssapi" id="id7">3.1&nbsp;&nbsp;&nbsp;GSSAPI</a></li>
-<li><a class="reference internal" href="#digest-md5" id="id8">3.2&nbsp;&nbsp;&nbsp;DIGEST-MD5</a></li>
-<li><a class="reference internal" href="#cram-md5" id="id9">3.3&nbsp;&nbsp;&nbsp;CRAM-MD5</a></li>
-<li><a class="reference internal" href="#login" id="id10">3.4&nbsp;&nbsp;&nbsp;LOGIN</a></li>
-<li><a class="reference internal" href="#plain" id="id11">3.5&nbsp;&nbsp;&nbsp;PLAIN</a></li>
+<li><a class="reference internal" href="#error-handling" id="id6">2&nbsp;&nbsp;&nbsp;Error Handling</a></li>
+<li><a class="reference internal" href="#smtp-authentication" id="id7">3&nbsp;&nbsp;&nbsp;SMTP Authentication</a><ul class="auto-toc">
+<li><a class="reference internal" href="#gssapi" id="id8">3.1&nbsp;&nbsp;&nbsp;GSSAPI</a></li>
+<li><a class="reference internal" href="#digest-md5" id="id9">3.2&nbsp;&nbsp;&nbsp;DIGEST-MD5</a></li>
+<li><a class="reference internal" href="#cram-md5" id="id10">3.3&nbsp;&nbsp;&nbsp;CRAM-MD5</a></li>
+<li><a class="reference internal" href="#login" id="id11">3.4&nbsp;&nbsp;&nbsp;LOGIN</a></li>
+<li><a class="reference internal" href="#plain" id="id12">3.5&nbsp;&nbsp;&nbsp;PLAIN</a></li>
+<li><a class="reference internal" href="#xoauth2" id="id13">3.6&nbsp;&nbsp;&nbsp;XOAUTH2</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#secure-connections" id="id12">4&nbsp;&nbsp;&nbsp;Secure Connections</a></li>
-<li><a class="reference internal" href="#sending-data" id="id13">5&nbsp;&nbsp;&nbsp;Sending Data</a></li>
-<li><a class="reference internal" href="#data-quoting" id="id14">6&nbsp;&nbsp;&nbsp;Data Quoting</a></li>
-<li><a class="reference internal" href="#server-responses" id="id15">7&nbsp;&nbsp;&nbsp;Server Responses</a></li>
-<li><a class="reference internal" href="#debugging" id="id16">8&nbsp;&nbsp;&nbsp;Debugging</a></li>
-<li><a class="reference internal" href="#examples" id="id17">9&nbsp;&nbsp;&nbsp;Examples</a><ul class="auto-toc">
-<li><a class="reference internal" href="#basic-use" id="id18">9.1&nbsp;&nbsp;&nbsp;Basic Use</a></li>
+<li><a class="reference internal" href="#secure-connections" id="id14">4&nbsp;&nbsp;&nbsp;Secure Connections</a></li>
+<li><a class="reference internal" href="#sending-data" id="id15">5&nbsp;&nbsp;&nbsp;Sending Data</a></li>
+<li><a class="reference internal" href="#data-quoting" id="id16">6&nbsp;&nbsp;&nbsp;Data Quoting</a></li>
+<li><a class="reference internal" href="#server-responses" id="id17">7&nbsp;&nbsp;&nbsp;Server Responses</a></li>
+<li><a class="reference internal" href="#debugging" id="id18">8&nbsp;&nbsp;&nbsp;Debugging</a></li>
+<li><a class="reference internal" href="#examples" id="id19">9&nbsp;&nbsp;&nbsp;Examples</a><ul class="auto-toc">
+<li><a class="reference internal" href="#basic-use" id="id20">9.1&nbsp;&nbsp;&nbsp;Basic Use</a></li>
 </ul>
 </li>
 </ul>
@@ -246,6 +247,11 @@ <h3>3.5&nbsp;&nbsp;&nbsp;PLAIN</h3>
 <p>The PLAIN authentication method sends the user's password in plain text.
 This method of authentication is not secure and should be avoided.</p>
 </div>
+<div class="section" id="xoauth2">
+<h3>3.6&nbsp;&nbsp;&nbsp;XOAUTH2</h3>
+<p>The XOAUTH2 authentication method sends a username and an OAuth2 access token
+as per <a class="reference external" href="https://developers.google.com/gmail/imap/xoauth2-protocol#smtp_protocol_exchange">Gmail's SASL XOAUTH2 documentation</a>.</p>
+</div>
 </div>
 <div class="section" id="secure-connections">
 <h2>4&nbsp;&nbsp;&nbsp;Secure Connections</h2>