Added a lot of documentation

Author: bbottema

src/main/webapp/dist/app.bundle.js

@@ -4,12 +4,14 @@ <h1>Configuration</h1>
 
   <section class="introduction">
     <p class="wide">
-      Simple Java Mail provides full configuration through <strong>programmatic API</strong> as well as <strong>properties files</strong>. For each
-      level of configuration detail, a constructor is available keep it simple.
+      Simple Java Mail provides full configuration through <strong>programmatic API</strong> as well as <strong>system variables</strong>, <strong>environment
+                                                                                                                                                   variables</strong>
+      and <strong>properties files</strong>. For each level of configuration detail, a simple constructor is available as well.
     </p>
     <p class="wide">
       The Java API and config files complement each other; the more you configure in a properties file, the less you can provide through the
-      programmatic API. If you provide the overlapping configuration, the programmatic API takes priority, overriding property values.
+      programmatic API. If you provide the overlapping configuration, the programmatic API takes priority, overriding system and environment values,
+      overriding property values.
     </p>
   </section>
 
@@ -105,6 +107,10 @@ <h3>Other settings</h3>
 // change SOCKS5 bridge port in case of authenticated proxy
 Proxyconfig proxyConfig = new ProxyConfig(...);
 proxyConfig.setProxyBridgePort(1081); // is always localhost
+</code></pre>
+<pre><code>
+// change maximum number of threads when sending asynchronously
+mailer.setThreadPoolSize(20);
 </code></pre>
     </div>
   </section>
@@ -116,12 +122,21 @@ <h2>Properties files</h2>
   <section>
     <div class="view">
       <p>
-        With properties files you can define defaults and overrides.
+        With properties files you can define defaults and overrides. You can also provide overriding value by defining system variables.
       </p>
       <p>
         Simple Java Mail will automatically load properties from <code class="inline">simplejavamail.properties</code>, if available on the classpath.
         Alternatively, you can manually load additional properties files in a number of ways.
       </p>
+      <p>
+        Properties are loaded in order of priority from high to low:
+      </p>
+      <ol class="indent">
+        <li>Programmatic values</li>
+        <li>System variables</li>
+        <li>Environment variables</li>
+        <li>Properties from config files</li>
+      </ol>
     </div>
 
     <div class="side">
@@ -165,6 +180,7 @@ <h3>Available properties</h3>
 [email protected]
 simplejavamail.defaults.bcc.name=BCC Default
 [email protected]
+simplejavamail.defaults.poolsize=10
 </code></pre>
     </div>
   </section>

src/main/webapp/dist/app.map

@@ -31,6 +31,7 @@ <h1>Simple Java Mail Features</h1>
       <li><a simplePageScroll href="#section-email-validation">Validating Email Addresses</a></li>
       <li><a simplePageScroll href="#section-generate-mimemessage">Generating a MimeMessage from an Email</a></li>
       <li><a simplePageScroll href="#section-parse-mimemessage">Generating an Email from a MimeMessage</a></li>
+      <li><a simplePageScroll href="#section-proxy">Send using a proxy</a></li>
     </ul>
   </section>
 
@@ -125,6 +126,32 @@ <h3>Configure once, reuse many times</h3>
   </section>
 
 
+  <a href="#section-sending-asynchronously" id="section-sending-asynchronously" class="section-link h3">&sect;</a>
+  <h3>Asynchronous parallel batch sending</h3>
+
+  <section>
+    <div class="view">
+      <p>
+        The default mode is to send emails synchronously, blocking execution until the email was processed completely and the STMP server send a
+        succesful result.
+      </p>
+      <p>
+        You can also sent anyschronously in parallel or batches, or simply send in a fire-and-forget way. If an authenticated proxy is used, the <a
+        simplePageScroll href="#section-proxy">proxy briding server</a> is kept alive until the last email has been sent.</p>
+      <p>
+        Depending on the SMTP server (and proxy server if used) this can greatly influence how fast emails are sent.
+      </p>
+    </div>
+
+    <div class="side">
+<pre><code>mailer.sendMail(email, true);
+</code></pre>
+      <p>Refer to the <a simplePageScroll [routerLink]="['/configuration']" simplePageScroll href="#section-other-settings">configuration section</a>
+         on how to set the thread pool size default.</p>
+    </div>
+  </section>
+
+
   <a href="#section-custom-session" id="section-custom-session" class="section-link h2">&sect;</a>
   <h2>Sending with your own Session instance</h2>
 
@@ -403,4 +430,39 @@ <h2>Generating an Email from a MimeMessage</h2>
     </div>
   </section>
 
+
+  <a href="#section-proxy" id="section-proxy" class="section-link h2">&sect;</a>
+  <h2>Send using a proxy</h2>
+
+  <section>
+    <div class="view">
+      <p>
+        Simple Java Mail supports sending emails through a proxy. It is also the only java mailing framework in the world that supports sending emails
+        through <strong>authenticated</strong> proxies.
+      </p>
+      <p>
+        The reason for this is that the underlying native <a href="https://java.net/projects/javamail/pages/Home">Javax Mail framework</a> supports
+        anonymous SOCKS5 proxies, but <a href="http://www.oracle.com/technetwork/java/javamail/faq/index.html#proxy">not authenticated proxies</a>.
+      </p>
+      <p>
+        To make this work with authentication, Simple Java Mail uses a trick: it sets up a temporary anonymous proxy server for Javax Mail to connect
+        to and then relays the connection to the target proxy performing the authentication outside of Javax Mail.
+      </p>
+      <p>
+        This temporary server is referred to as the <strong>Proxy Bridging Server</strong>.
+      </p>
+    </div>
+
+    <div class="side">
+<pre><code>// anonymous proxy
+new Mailer(serverConfig, new ProxyConfig("proxy.host.com", 1080));
+
+// authenticated proxy
+new Mailer(serverConfig, new ProxyConfig("proxy.host.com", 1080, "proxy username", "proxy password"));
+</code></pre>
+      <p>Refer to the <a simplePageScroll [routerLink]="['/configuration']" simplePageScroll href="#section-other-settings">configuration section</a>
+         on how to set proxy server defaults and the port on which the proxy bridge runs.</p>
+    </div>
+  </section>
+
 </div>

src/main/webapp/src/app/components/configuration/configuration.html

@@ -1,9 +1,10 @@
 import {Component} from '@angular/core';
 import {SimplePageScroll, SimplePageScrollConfig} from 'ng2-simple-page-scroll';
+import {ROUTER_DIRECTIVES} from '@angular/router'; // needed for SimplePageScroll to nav to other views
 
 @Component({
   template: require('app/components/features/features.html'),
-  directives: [SimplePageScroll]
+  directives: [ROUTER_DIRECTIVES, SimplePageScroll]
 })
 
 export class Features {