From 51ae5d9b5f9fa77f9de76fe99c32de8d46051906 Mon Sep 17 00:00:00 2001
From: bbottema <b.bottema@projectnibble.org>
Date: Sun, 3 Jun 2018 17:05:46 +0200
Subject: [PATCH] #144: added multipart structure browser in the RFC Compliance
 page

---
 src/main/webapp/src/app.ts                    |  2 +
 .../webapp/src/app/components/rfc/Email.ts    | 10 ++++
 .../src/app/components/rfc/MessageStrategy.ts | 22 ++++++++
 .../rfc/MessageStrategyAlternative.ts         | 22 ++++++++
 .../components/rfc/MessageStrategyMixed.ts    | 24 ++++++++
 .../rfc/MessageStrategyMixedAlternative.ts    | 28 ++++++++++
 .../rfc/MessageStrategyMixedRelated.ts        | 27 +++++++++
 .../MessageStrategyMixedRelatedAlternative.ts | 34 ++++++++++++
 .../components/rfc/MessageStrategyRelated.ts  | 21 +++++++
 .../rfc/MessageStrategyRelatedAlternative.ts  | 25 +++++++++
 .../components/rfc/MessageStrategySimple.ts   | 19 +++++++
 .../webapp/src/app/components/rfc/rfc.html    | 44 +++++++++++++++
 src/main/webapp/src/app/components/rfc/rfc.ts | 55 ++++++++++++++++++-
 13 files changed, 331 insertions(+), 2 deletions(-)
 create mode 100644 src/main/webapp/src/app/components/rfc/Email.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategy.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategyAlternative.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategyMixed.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategyMixedAlternative.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategyMixedRelated.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategyMixedRelatedAlternative.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategyRelated.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategyRelatedAlternative.ts
 create mode 100644 src/main/webapp/src/app/components/rfc/MessageStrategySimple.ts

diff --git a/src/main/webapp/src/app.ts b/src/main/webapp/src/app.ts
index fa97f36fa..15bd80305 100644
--- a/src/main/webapp/src/app.ts
+++ b/src/main/webapp/src/app.ts
@@ -1,5 +1,6 @@
 import { NgModule, enableProdMode } from '@angular/core'
 import { RouterModule } from '@angular/router';
+import { FormsModule } from '@angular/forms';
 import { rootRouterConfig } from './app/simple-java-mail-routes';
 import { SimpleJavaMailApp } from './app/simple-java-mail-app';
 import { BrowserModule } from '@angular/platform-browser';
@@ -37,6 +38,7 @@ require('./index.html');
   imports: [
     BrowserModule,
     HttpModule,
+    FormsModule,
     RouterModule.forRoot(rootRouterConfig, { useHash: true }),
     Ng2SimplePageScrollModule.forRoot()
   ],
diff --git a/src/main/webapp/src/app/components/rfc/Email.ts b/src/main/webapp/src/app/components/rfc/Email.ts
new file mode 100644
index 000000000..0aacb3412
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/Email.ts
@@ -0,0 +1,10 @@
+export class Email {
+  constructor(readonly usePlainText: boolean,
+              readonly useHTMLText: boolean,
+              readonly useEmbeddedContent: boolean,
+              readonly useCalendarEvent: boolean,
+              readonly useAttachments: boolean,
+              readonly useEmailForward: boolean,
+  ) {
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategy.ts b/src/main/webapp/src/app/components/rfc/MessageStrategy.ts
new file mode 100644
index 000000000..ae691a73f
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategy.ts
@@ -0,0 +1,22 @@
+import {Email} from "./Email";
+
+export abstract class MessageStrategy {
+  
+  abstract compatibleWithEmail(email: Email): boolean;
+  
+  abstract determineMessageStructure(email: Email): string;
+  
+  protected static emailContainsMixedContent(email: Email): boolean {
+    return email.useAttachments || email.useEmailForward;
+  }
+  
+  protected static emailContainsRelatedContent(email: Email): boolean {
+    return email.useEmbeddedContent;
+  }
+  
+  protected static emailContainsAlternativeContent(email: Email): boolean {
+    return (email.usePlainText ? 1 : 0) +
+      (email.useHTMLText ? 1 : 0) +
+      (email.useCalendarEvent ? 1 : 0) > 1;
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategyAlternative.ts b/src/main/webapp/src/app/components/rfc/MessageStrategyAlternative.ts
new file mode 100644
index 000000000..99c3fd889
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategyAlternative.ts
@@ -0,0 +1,22 @@
+import {MessageStrategy} from "./MessageStrategy";
+import {Email} from "./Email";
+
+export class MessageStrategyAlternative extends MessageStrategy {
+  compatibleWithEmail(email: Email): boolean {
+    return !MessageStrategy.emailContainsMixedContent(email) &&
+      !MessageStrategy.emailContainsRelatedContent(email) &&
+      MessageStrategy.emailContainsAlternativeContent(email);
+  }
+  
+  public determineMessageStructure(email: Email): string {
+    return "<ul>" +
+      "  <li class=\"indent\">alternative (root)" +
+      "     <ul>" +
+      (email.usePlainText ? "<li class=\"indent\">Plain text</li>" : "") +
+      (email.useHTMLText ? "<li class=\"indent\">HTML text</li>" : "") +
+      (email.useCalendarEvent ? "<li class=\"indent\">iCalendar text</li>" : "") +
+      "     </ul>" +
+      "   </li>" +
+      "</ul>";
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategyMixed.ts b/src/main/webapp/src/app/components/rfc/MessageStrategyMixed.ts
new file mode 100644
index 000000000..818a8a8f0
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategyMixed.ts
@@ -0,0 +1,24 @@
+import {Email} from "./Email";
+import {MessageStrategy} from "./MessageStrategy";
+
+export class MessageStrategyMixed extends MessageStrategy {
+  compatibleWithEmail(email: Email): boolean {
+		return MessageStrategy.emailContainsMixedContent(email) &&
+      !MessageStrategy.emailContainsRelatedContent(email) &&
+      !MessageStrategy.emailContainsAlternativeContent(email);
+	}
+  
+  public determineMessageStructure(email: Email): string {
+    return "<ul>" +
+      "  <li class=\"indent\">mixed (root)" +
+      "     <ul>" +
+      (email.usePlainText ? "<li class=\"indent\">Plain text</li>" : "") +
+      (email.useHTMLText ? "<li class=\"indent\">HTML text</li>" : "") +
+      (email.useCalendarEvent ? "<li class=\"indent\">iCalendar text</li>" : "") +
+      (email.useEmailForward ? "<li class=\"indent\">forwarded email</li>" : "") +
+      (email.useAttachments ? "<li class=\"indent\">downloadable attachments</li>" : "") +
+      "     </ul>" +
+      "   </li>" +
+      "</ul>";
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategyMixedAlternative.ts b/src/main/webapp/src/app/components/rfc/MessageStrategyMixedAlternative.ts
new file mode 100644
index 000000000..c92d1e985
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategyMixedAlternative.ts
@@ -0,0 +1,28 @@
+import {Email} from "./Email";
+import {MessageStrategy} from "./MessageStrategy";
+
+export class MessageStrategyMixedAlternative extends MessageStrategy {
+  compatibleWithEmail(email: Email): boolean {
+    return MessageStrategy.emailContainsMixedContent(email) &&
+      !MessageStrategy.emailContainsRelatedContent(email) &&
+      MessageStrategy.emailContainsAlternativeContent(email);
+  }
+  
+  public determineMessageStructure(email: Email): string {
+    return "<ul>" +
+      "   <li class=\"indent\">mixed (root)" +
+      "     <ul>" +
+      "		    <li class=\"indent\">alternative" +
+      "         <ul>" +
+      (email.usePlainText ? "<li class=\"indent\">Plain text</li>" : "") +
+      (email.useHTMLText ? "<li class=\"indent\">HTML text</li>" : "") +
+      (email.useCalendarEvent ? "<li class=\"indent\">iCalendar text</li>" : "") +
+      "		      </ul>" +
+      "       </li>" +
+      (email.useEmailForward ? "<li class=\"indent\">forwarded email</li>" : "") +
+      (email.useAttachments ? "<li class=\"indent\">downloadable attachments</li>" : "") +
+      "	    </ul>" +
+      "   </li>" +
+      "</ul>";
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategyMixedRelated.ts b/src/main/webapp/src/app/components/rfc/MessageStrategyMixedRelated.ts
new file mode 100644
index 000000000..90affae87
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategyMixedRelated.ts
@@ -0,0 +1,27 @@
+import {Email} from "./Email";
+import {MessageStrategy} from "./MessageStrategy";
+
+export class MessageStrategyMixedRelated extends MessageStrategy {
+  compatibleWithEmail(email: Email): boolean {
+		return MessageStrategy.emailContainsMixedContent(email) &&
+      MessageStrategy.emailContainsRelatedContent(email) &&
+      !MessageStrategy.emailContainsAlternativeContent(email);
+	}
+  
+  public determineMessageStructure(email: Email): string {
+    return "<ul>" +
+      "   <li class=\"indent\">mixed (root)" +
+      "     <ul>" +
+      "		    <li class=\"indent\">related" +
+      "         <ul>" +
+      "			      <li class=\"indent\">HTML text</li>" +
+      "			      <li class=\"indent\">embeddable content (ie. images)</li>" +
+      "		      </ul>" +
+      "       </li>" +
+      (email.useEmailForward ? "<li class=\"indent\">forwarded email</li>" : "") +
+      (email.useAttachments ? "<li class=\"indent\">downloadable attachments</li>" : "") +
+      "	    </ul>" +
+      "   </li>" +
+      "</ul>";
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategyMixedRelatedAlternative.ts b/src/main/webapp/src/app/components/rfc/MessageStrategyMixedRelatedAlternative.ts
new file mode 100644
index 000000000..3cf47445b
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategyMixedRelatedAlternative.ts
@@ -0,0 +1,34 @@
+import {Email} from "./Email";
+import {MessageStrategy} from "./MessageStrategy";
+
+export class MessageStrategyMixedRelatedAlternative extends MessageStrategy {
+  
+  compatibleWithEmail(email: Email): boolean {
+		return MessageStrategy.emailContainsMixedContent(email) &&
+      MessageStrategy.emailContainsRelatedContent(email) &&
+      MessageStrategy.emailContainsAlternativeContent(email);
+	}
+  
+  public determineMessageStructure(email: Email): string {
+    return "<ul>" +
+      "   <li class=\"indent\">mixed (root)" +
+      "     <ul>" +
+      "   	  <li class=\"indent\">related" +
+      "         <ul>" +
+      "     	  	<li class=\"indent\">alternative" +
+      "             <ul>" +
+      (email.usePlainText ? "<li class=\"indent\">Plain text</li>" : "") +
+      (email.useHTMLText ? "<li class=\"indent\">HTML text</li>" : "") +
+      (email.useCalendarEvent ? "<li class=\"indent\">iCalendar text</li>" : "") +
+      "             </ul>" +
+      "           </li>" +
+      "		  	    <li class=\"indent\">embeddable content (ie. images) </li>" +
+      "         </ul>" +
+      "       </li>" +
+      (email.useEmailForward ? "<li class=\"indent\">forwarded email</li>" : "") +
+      (email.useAttachments ? "<li class=\"indent\">downloadable attachments</li>" : "") +
+      "	    </ul>" +
+      "   </li>" +
+      "</ul>";
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategyRelated.ts b/src/main/webapp/src/app/components/rfc/MessageStrategyRelated.ts
new file mode 100644
index 000000000..08a0978df
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategyRelated.ts
@@ -0,0 +1,21 @@
+import {Email} from "./Email";
+import {MessageStrategy} from "./MessageStrategy";
+
+export class MessageStrategyRelated extends MessageStrategy {
+  compatibleWithEmail(email: Email): boolean {
+		return !MessageStrategy.emailContainsMixedContent(email) &&
+      MessageStrategy.emailContainsRelatedContent(email) &&
+      !MessageStrategy.emailContainsAlternativeContent(email);
+	}
+  
+  public determineMessageStructure(email: Email): string {
+    return "<ul>" +
+      "  <li class=\"indent\">related (root)" +
+      "     <ul>" +
+      "     <li class=\"indent\">HTML text</li>" +
+      "     <li class=\"indent\">embeddable content (ie. images)</li>" +
+      "     </ul>" +
+      "   </li>" +
+      "</ul>";
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategyRelatedAlternative.ts b/src/main/webapp/src/app/components/rfc/MessageStrategyRelatedAlternative.ts
new file mode 100644
index 000000000..53644b5b6
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategyRelatedAlternative.ts
@@ -0,0 +1,25 @@
+import {Email} from "./Email";
+import {MessageStrategy} from "./MessageStrategy";
+
+export class MessageStrategyRelatedAlternative extends MessageStrategy {
+  compatibleWithEmail(email: Email): boolean {
+    return !MessageStrategy.emailContainsMixedContent(email) &&
+      MessageStrategy.emailContainsRelatedContent(email) &&
+      MessageStrategy.emailContainsAlternativeContent(email);
+  }
+  
+  public determineMessageStructure(email: Email): string {
+    return "<ul>" +
+      "   <li class=\"indent\">related (root)<ul>" +
+      "   	<li class=\"indent\">alternative" +
+      "       <ul>" +
+      (email.usePlainText ? "<li class=\"indent\">Plain text</li>" : "") +
+      (email.useHTMLText ? "<li class=\"indent\">HTML text</li>" : "") +
+      (email.useCalendarEvent ? "<li class=\"indent\">iCalendar text</li>" : "") +
+      "		    </ul>" +
+      "    </li>" +
+      "		<li class=\"indent\">embeddable content (ie. images)</li>" +
+      "	</ul>" +
+      "</li>";
+  }
+}
diff --git a/src/main/webapp/src/app/components/rfc/MessageStrategySimple.ts b/src/main/webapp/src/app/components/rfc/MessageStrategySimple.ts
new file mode 100644
index 000000000..ccf17d54e
--- /dev/null
+++ b/src/main/webapp/src/app/components/rfc/MessageStrategySimple.ts
@@ -0,0 +1,19 @@
+import {MessageStrategy} from "./MessageStrategy";
+import {Email} from "./Email";
+
+export class MessageStrategySimple extends MessageStrategy {
+  
+  compatibleWithEmail(email: Email): boolean {
+		return !MessageStrategy.emailContainsMixedContent(email) &&
+      !MessageStrategy.emailContainsRelatedContent(email) &&
+      !MessageStrategy.emailContainsAlternativeContent(email);
+	}
+	
+	public determineMessageStructure(email: Email): string {
+    return "<ul>" +
+      (email.usePlainText ? "<li class=\"indent\">Plain text (root)</li>" : "") +
+      (email.useHTMLText ? "<li class=\"indent\">HTML text (root)</li>" : "") +
+      (email.useCalendarEvent ? "<li class=\"indent\">iCalendar text (root)</li>" : "") +
+      "     </ul>";
+	}
+}
diff --git a/src/main/webapp/src/app/components/rfc/rfc.html b/src/main/webapp/src/app/components/rfc/rfc.html
index f0466e90f..b62220cec 100644
--- a/src/main/webapp/src/app/components/rfc/rfc.html
+++ b/src/main/webapp/src/app/components/rfc/rfc.html
@@ -6,6 +6,7 @@ <h1>Simple Java Mail is fully RFC compliant</h1>
     <ul>
       <li><a simplePageScroll href="#section-why">Why RFC compliancy matters</a></li>
       <li><a simplePageScroll href="#section-how">How is Simple Java Mail RFC compliant?</a></li>
+      <li><a simplePageScroll href="#section-explore-multipart">Explore the multipart structures used by Simple Java Mail</a></li>
     </ul>
   </section>
 
@@ -64,4 +65,47 @@ <h2>How is Simple Java Mail RFC compliant?</h2>
       </ol>
     </div>
   </section>
+  
+  
+  <a href="#section-explore-multipart" id="#section-explore-multipart" class="section-link h2">&sect;</a>
+  <h2>Explore the multipart structures used by Simple Java Mail</h2>
+  
+  <section>
+    <div class="view">
+      <p>Configure your email:</p>
+  
+      <form>
+        <div>
+          <input type="checkbox" id="usePlainText" name="usePlainText" [(ngModel)]="usePlainText" (ngModelChange)="updateMessageStructure()">
+          <label for="usePlainText">Plain text body</label>
+        </div>
+        <div>
+          <input type="checkbox" id="useHTMLText" name="useHTMLText" [(ngModel)]="useHTMLText" (ngModelChange)="updateMessageStructure()">
+          <label for="useHTMLText">HTML text body</label>
+        </div>
+        <div class="indent">
+          <input type="checkbox" id="useEmbeddedContent" name="useEmbeddedContent" [(ngModel)]="useEmbeddedContent" (ngModelChange)="updateMessageStructure()"
+                 [disabled]="!useHTMLText">
+          <label for="useEmbeddedContent">HTML body contains embedded content (such as image)</label>
+        </div>
+        <div>
+          <input type="checkbox" id="useCalendarEvent" name="useCalendarEvent" [(ngModel)]="useCalendarEvent" (ngModelChange)="updateMessageStructure()">
+          <label for="useCalendarEvent">iCalendar event</label>
+        </div>
+        <div>
+          <input type="checkbox" id="useAttachments" name="useAttachments" [(ngModel)]="useAttachments" (ngModelChange)="updateMessageStructure()">
+          <label for="useAttachments">Downloadable attachments</label>
+        </div>
+        <div>
+          <input type="checkbox" id="useEmailForward" name="useEmailForward" [(ngModel)]="useEmailForward" (ngModelChange)="updateMessageStructure()">
+          <label for="useEmailForward">Forwards another email</label>
+        </div>
+      </form>
+      
+    </div>
+    <div class="side padded">
+      <p>Structure used for email:</p>
+      <div [innerHTML]="messageStructure"></div>
+    </div>
+  </section>
 </div>
diff --git a/src/main/webapp/src/app/components/rfc/rfc.ts b/src/main/webapp/src/app/components/rfc/rfc.ts
index b4d730134..58444055e 100644
--- a/src/main/webapp/src/app/components/rfc/rfc.ts
+++ b/src/main/webapp/src/app/components/rfc/rfc.ts
@@ -1,8 +1,59 @@
-import {Component} from '@angular/core';
+import {Component, Input} from '@angular/core';
+import {MessageStrategy} from "./MessageStrategy";
+import {MessageStrategyAlternative} from "./MessageStrategyAlternative";
+import {MessageStrategyMixed} from "./MessageStrategyMixed";
+import {MessageStrategyRelated} from "./MessageStrategyRelated";
+import {MessageStrategyMixedRelatedAlternative} from "./MessageStrategyMixedRelatedAlternative";
+import {MessageStrategyRelatedAlternative} from "./MessageStrategyRelatedAlternative";
+import {MessageStrategyMixedAlternative} from "./MessageStrategyMixedAlternative";
+import {MessageStrategyMixedRelated} from "./MessageStrategyMixedRelated";
+import {MessageStrategySimple} from "./MessageStrategySimple";
+import {Email} from "./Email";
 
 @Component({
   template: require('./rfc.html')
 })
-
 export class RfcCompliant {
+  @Input() usePlainText: boolean;
+  @Input() useHTMLText: boolean;
+  @Input() useEmbeddedContent: boolean;
+  @Input() useCalendarEvent: boolean;
+  @Input() useAttachments: boolean;
+  @Input() useEmailForward: boolean;
+  
+  messageStructure: string;
+  
+  private static readonly STRATEGIES: Array<MessageStrategy> = [
+    new MessageStrategySimple(),
+    new MessageStrategyAlternative(),
+    new MessageStrategyRelated(),
+    new MessageStrategyMixed(),
+    new MessageStrategyMixedRelated(),
+    new MessageStrategyMixedAlternative(),
+    new MessageStrategyRelatedAlternative(),
+    new MessageStrategyMixedRelatedAlternative()
+  ];
+  
+  updateMessageStructure(): void {
+    if (!this.useHTMLText) {
+      this.useEmbeddedContent = false;
+    }
+    
+    this.messageStructure = RfcCompliant.determineFormalStructure(new Email(
+      this.usePlainText,
+      this.useHTMLText,
+      this.useEmbeddedContent,
+      this.useCalendarEvent,
+      this.useAttachments,
+      this.useEmailForward));
+  }
+  
+  private static determineFormalStructure(email: Email): string {
+    for (const s of RfcCompliant.STRATEGIES) {
+      if (s.compatibleWithEmail(email)) {
+        return s.determineMessageStructure(email);
+      }
+    }
+    throw new Error("email config not recognized properly");
+  }
 }