Update User Guide

installation/upgrade_emails.html

@@ -290,7 +290,7 @@
 <li><p>Within your class change the <code class="docutils literal notranslate"><span class="pre">$this-&gt;load-&gt;library('email');</span></code> to <code class="docutils literal notranslate"><span class="pre">$email</span> <span class="pre">=</span> <span class="pre">service('email');</span></code>.</p></li>
 <li><p>From that on you have to replace every line starting with <code class="docutils literal notranslate"><span class="pre">$this-&gt;email</span></code> to <code class="docutils literal notranslate"><span class="pre">$email</span></code>.</p></li>
 <li><p>The methods in the Email class are named slightly different. All methods, except for <code class="docutils literal notranslate"><span class="pre">send()</span></code>, <code class="docutils literal notranslate"><span class="pre">attach()</span></code>, <code class="docutils literal notranslate"><span class="pre">printDebugger()</span></code> and <code class="docutils literal notranslate"><span class="pre">clear()</span></code> have a <code class="docutils literal notranslate"><span class="pre">set</span></code> as prefix followed by the previous method name. <code class="docutils literal notranslate"><span class="pre">bcc()</span></code> is now <code class="docutils literal notranslate"><span class="pre">setBcc()</span></code> and so on.</p></li>
-<li><p>The config attributes in <code class="docutils literal notranslate"><span class="pre">app/Config/Email.php</span></code> have changed. You should have a look at the <a class="reference external" href="/libraries/email.html#setting-email-preferences">Email Class Documentation</a> to have a list of the new attributes.</p></li>
+<li><p>The config attributes in <strong>app/Config/Email.php</strong> have changed. You should have a look at the <a class="reference internal" href="../libraries/email.html#setting-email-preferences"><span class="std std-ref">Setting Email Preferences</span></a> to have a list of the new attributes.</p></li>
 </ol>
 </section>
 <section id="code-example">

libraries/email.html

@@ -277,22 +277,22 @@ BCC batches.</p></li>
 </ul>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><p><a class="reference internal" href="#using-the-email-library" id="id1">Using the Email Library</a></p>
+<li><p><a class="reference internal" href="#using-the-email-library" id="id2">Using the Email Library</a></p>
 <ul>
-<li><p><a class="reference internal" href="#sending-email" id="id2">Sending Email</a></p></li>
-<li><p><a class="reference internal" href="#setting-email-preferences" id="id3">Setting Email Preferences</a></p></li>
-<li><p><a class="reference internal" href="#ssl-versus-tls-for-smtp-protocol" id="id4">SSL versus TLS for SMTP Protocol</a></p></li>
-<li><p><a class="reference internal" href="#email-preferences" id="id5">Email Preferences</a></p></li>
-<li><p><a class="reference internal" href="#overriding-word-wrapping" id="id6">Overriding Word Wrapping</a></p></li>
+<li><p><a class="reference internal" href="#sending-email" id="id3">Sending Email</a></p></li>
+<li><p><a class="reference internal" href="#setting-email-preferences" id="id4">Setting Email Preferences</a></p></li>
+<li><p><a class="reference internal" href="#ssl-versus-tls-for-smtp-protocol" id="id5">SSL versus TLS for SMTP Protocol</a></p></li>
+<li><p><a class="reference internal" href="#email-preferences" id="id6">Email Preferences</a></p></li>
+<li><p><a class="reference internal" href="#overriding-word-wrapping" id="id7">Overriding Word Wrapping</a></p></li>
 </ul>
 </li>
-<li><p><a class="reference internal" href="#class-reference" id="id7">Class Reference</a></p></li>
+<li><p><a class="reference internal" href="#class-reference" id="id8">Class Reference</a></p></li>
 </ul>
 </div>
 <section id="using-the-email-library">
-<h2><a class="toc-backref" href="#id1">Using the Email Library</a><a class="headerlink" href="#using-the-email-library" title="Permalink to this headline"></a></h2>
+<h2><a class="toc-backref" href="#id2">Using the Email Library</a><a class="headerlink" href="#using-the-email-library" title="Permalink to this headline"></a></h2>
 <section id="sending-email">
-<h3><a class="toc-backref" href="#id2">Sending Email</a><a class="headerlink" href="#sending-email" title="Permalink to this headline"></a></h3>
+<h3><a class="toc-backref" href="#id3">Sending Email</a><a class="headerlink" href="#sending-email" title="Permalink to this headline"></a></h3>
 <p>Sending email is not only simple, but you can configure it on the fly or
 set your preferences in the <strong>app/Config/Email.php</strong> file.</p>
 <p>Here is a basic example demonstrating how you might send email:</p>
@@ -311,7 +311,7 @@ set your preferences in the <strong>app/Config/Email.php</strong> file.</p>
 </div>
 </section>
 <section id="setting-email-preferences">
-<h3><a class="toc-backref" href="#id3">Setting Email Preferences</a><a class="headerlink" href="#setting-email-preferences" title="Permalink to this headline"></a></h3>
+<span id="id1"></span><h3><a class="toc-backref" href="#id4">Setting Email Preferences</a><a class="headerlink" href="#setting-email-preferences" title="Permalink to this headline"></a></h3>
 <p>There are 21 different preferences available to tailor how your email
 messages are sent. You can either set them manually as described here,
 or automatically via preferences stored in your config file, described
@@ -349,7 +349,7 @@ to determine that actual values at the time of the <code class="docutils literal
 </section>
 </section>
 <section id="ssl-versus-tls-for-smtp-protocol">
-<h3><a class="toc-backref" href="#id4">SSL versus TLS for SMTP Protocol</a><a class="headerlink" href="#ssl-versus-tls-for-smtp-protocol" title="Permalink to this headline"></a></h3>
+<h3><a class="toc-backref" href="#id5">SSL versus TLS for SMTP Protocol</a><a class="headerlink" href="#ssl-versus-tls-for-smtp-protocol" title="Permalink to this headline"></a></h3>
 <p>To protect the username, password and email content while communicating with the SMTP server,
 encryption on the channel should be used. Two different standards are widely deployed and
 it is important to understand the differences when trying to troubleshoot email sending
@@ -371,7 +371,7 @@ with the SMTP server to switch from clear-text to an encrypted channel. The init
 will be made in clear-text and the channel will be upgraded to TLS with the <code class="docutils literal notranslate"><span class="pre">STARTTLS</span></code> command.</p>
 </section>
 <section id="email-preferences">
-<h3><a class="toc-backref" href="#id5">Email Preferences</a><a class="headerlink" href="#email-preferences" title="Permalink to this headline"></a></h3>
+<h3><a class="toc-backref" href="#id6">Email Preferences</a><a class="headerlink" href="#email-preferences" title="Permalink to this headline"></a></h3>
 <p>The following is a list of all the preferences that can be set when
 sending email.</p>
 <table class="docutils align-default">
@@ -504,7 +504,7 @@ paths otherwise they will not work.</p></td>
 </table>
 </section>
 <section id="overriding-word-wrapping">
-<h3><a class="toc-backref" href="#id6">Overriding Word Wrapping</a><a class="headerlink" href="#overriding-word-wrapping" title="Permalink to this headline"></a></h3>
+<h3><a class="toc-backref" href="#id7">Overriding Word Wrapping</a><a class="headerlink" href="#overriding-word-wrapping" title="Permalink to this headline"></a></h3>
 <p>If you have word wrapping enabled (recommended to comply with RFC 822)
 and you have a very long link in your email it can get wrapped too,
 causing it to become un-clickable by the person receiving it.
@@ -523,7 +523,7 @@ message like this:</p>
 </section>
 </section>
 <section id="class-reference">
-<h2><a class="toc-backref" href="#id7">Class Reference</a><a class="headerlink" href="#class-reference" title="Permalink to this headline"></a></h2>
+<h2><a class="toc-backref" href="#id8">Class Reference</a><a class="headerlink" href="#class-reference" title="Permalink to this headline"></a></h2>
 <dl class="class">
 <dt>
 <code class="sig-name descname">CodeIgniter\Email\Email</code></dt>