From b4dcbc98461b46e6afa04bfda1f4d55208252a07 Mon Sep 17 00:00:00 2001
From: Mike Koch <mkoch227@gmail.com>
Date: Thu, 16 Feb 2017 22:04:51 -0500
Subject: [PATCH] Getting started on email sender for customer ticket creation

---
 api/BusinessLogic/Emails/EmailBuilder.php     | 14 +++++
 api/BusinessLogic/Emails/EmailSender.php      | 25 ++++++++
 .../Emails/MailgunEmailSender.php             | 29 +++++++++
 .../Emails/PhpMailEmailSender.php             | 29 +++++++++
 api/BusinessLogic/Emails/StmpEmailSender.php  | 29 +++++++++
 api/BusinessLogic/Security/BannedEmail.php    |  6 --
 api/BusinessLogic/Security/BannedIp.php       |  6 --
 .../Security/UserContextNotifications.php     |  6 --
 .../Security/UserContextPreferences.php       |  6 --
 api/BusinessLogic/Statuses/Closable.php       |  6 --
 .../Statuses/DefaultStatusForAction.php       |  6 --
 api/BusinessLogic/Statuses/StatusLanguage.php |  6 --
 api/BusinessLogic/Tickets/Attachment.php      |  6 --
 api/BusinessLogic/Tickets/Autoassigner.php    |  6 --
 .../CustomFields/CustomFieldValidator.php     |  6 --
 .../Tickets/TicketGatewayGeneratedFields.php  |  6 --
 api/BusinessLogic/Tickets/TicketRetriever.php |  6 --
 api/BusinessLogic/Validators.php              |  6 --
 api/Controllers/JsonRetriever.php             |  6 --
 api/Core/Constants/CustomField.php            |  6 --
 api/DataAccess/Statuses/StatusGateway.php     |  1 -
 .../Security/BanRetrieverTest.php             |  6 --
 .../CustomFields/CustomFieldValidatorTest.php |  6 --
 .../Tickets/NewTicketValidatorTest.php        |  6 --
 .../CreateTicketForCustomerTest.php           |  6 --
 .../Tickets/TrackingIdGeneratorTest.php       |  6 --
 api/composer.json                             |  3 +-
 api/composer.lock                             | 62 ++++++++++++++++++-
 28 files changed, 189 insertions(+), 123 deletions(-)
 create mode 100644 api/BusinessLogic/Emails/EmailBuilder.php
 create mode 100644 api/BusinessLogic/Emails/EmailSender.php
 create mode 100644 api/BusinessLogic/Emails/MailgunEmailSender.php
 create mode 100644 api/BusinessLogic/Emails/PhpMailEmailSender.php
 create mode 100644 api/BusinessLogic/Emails/StmpEmailSender.php

diff --git a/api/BusinessLogic/Emails/EmailBuilder.php b/api/BusinessLogic/Emails/EmailBuilder.php
new file mode 100644
index 00000000..62739d00
--- /dev/null
+++ b/api/BusinessLogic/Emails/EmailBuilder.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace BusinessLogic\Emails;
+
+
+class EmailBuilder {
+    private $to;
+    private $cc;
+    private $bcc;
+    private $subject;
+    private $message;
+    private $htmlMessage;
+    private $attachments;
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Emails/EmailSender.php b/api/BusinessLogic/Emails/EmailSender.php
new file mode 100644
index 00000000..75f25e68
--- /dev/null
+++ b/api/BusinessLogic/Emails/EmailSender.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace BusinessLogic\Emails;
+
+
+use BusinessLogic\Tickets\Attachment;
+use BusinessLogic\Tickets\Ticket;
+
+interface EmailSender {
+    /**
+     * @param $emailBuilder EmailBuilder
+     * @param $heskSettings array
+     * @param $modsForHeskSettings array
+     */
+    function sendEmail($emailBuilder, $heskSettings, $modsForHeskSettings);
+
+    /**
+     * @param $emailBuilder EmailBuilder
+     * @param $ticket Ticket
+     * @param $attachments Attachment[]
+     * @param $heskSettings array
+     * @param $modsForHeskSettings array
+     */
+    function sendEmailWithTicket($emailBuilder, $ticket, $attachments, $heskSettings, $modsForHeskSettings);
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Emails/MailgunEmailSender.php b/api/BusinessLogic/Emails/MailgunEmailSender.php
new file mode 100644
index 00000000..c29df57e
--- /dev/null
+++ b/api/BusinessLogic/Emails/MailgunEmailSender.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace BusinessLogic\Emails;
+
+
+use BusinessLogic\Tickets\Attachment;
+use BusinessLogic\Tickets\Ticket;
+
+class MailgunEmailSender implements EmailSender {
+    /**
+     * @param $emailBuilder EmailBuilder
+     * @param $heskSettings array
+     * @param $modsForHeskSettings array
+     */
+    function sendEmail($emailBuilder, $heskSettings, $modsForHeskSettings) {
+        // TODO: Implement sendEmail() method.
+    }
+
+    /**
+     * @param $emailBuilder EmailBuilder
+     * @param $ticket Ticket
+     * @param $attachments Attachment[]
+     * @param $heskSettings array
+     * @param $modsForHeskSettings array
+     */
+    function sendEmailWithTicket($emailBuilder, $ticket, $attachments, $heskSettings, $modsForHeskSettings) {
+        // TODO: Implement sendEmailWithTicket() method.
+    }
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Emails/PhpMailEmailSender.php b/api/BusinessLogic/Emails/PhpMailEmailSender.php
new file mode 100644
index 00000000..56086090
--- /dev/null
+++ b/api/BusinessLogic/Emails/PhpMailEmailSender.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace BusinessLogic\Emails;
+
+
+use BusinessLogic\Tickets\Attachment;
+use BusinessLogic\Tickets\Ticket;
+
+class PhpMailEmailSender implements EmailSender {
+    /**
+     * @param $emailBuilder EmailBuilder
+     * @param $heskSettings array
+     * @param $modsForHeskSettings array
+     */
+    function sendEmail($emailBuilder, $heskSettings, $modsForHeskSettings) {
+        // TODO: Implement sendEmail() method.
+    }
+
+    /**
+     * @param $emailBuilder EmailBuilder
+     * @param $ticket Ticket
+     * @param $attachments Attachment[]
+     * @param $heskSettings array
+     * @param $modsForHeskSettings array
+     */
+    function sendEmailWithTicket($emailBuilder, $ticket, $attachments, $heskSettings, $modsForHeskSettings) {
+        // TODO: Implement sendEmailWithTicket() method.
+    }
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Emails/StmpEmailSender.php b/api/BusinessLogic/Emails/StmpEmailSender.php
new file mode 100644
index 00000000..329dc9c3
--- /dev/null
+++ b/api/BusinessLogic/Emails/StmpEmailSender.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace BusinessLogic\Emails;
+
+
+use BusinessLogic\Tickets\Attachment;
+use BusinessLogic\Tickets\Ticket;
+
+class StmpEmailSender implements EmailSender {
+    /**
+     * @param $emailBuilder EmailBuilder
+     * @param $heskSettings array
+     * @param $modsForHeskSettings array
+     */
+    function sendEmail($emailBuilder, $heskSettings, $modsForHeskSettings) {
+        // TODO: Implement sendEmail() method.
+    }
+
+    /**
+     * @param $emailBuilder EmailBuilder
+     * @param $ticket Ticket
+     * @param $attachments Attachment[]
+     * @param $heskSettings array
+     * @param $modsForHeskSettings array
+     */
+    function sendEmailWithTicket($emailBuilder, $ticket, $attachments, $heskSettings, $modsForHeskSettings) {
+        // TODO: Implement sendEmailWithTicket() method.
+    }
+}
\ No newline at end of file
diff --git a/api/BusinessLogic/Security/BannedEmail.php b/api/BusinessLogic/Security/BannedEmail.php
index 8b612ed9..691a6604 100644
--- a/api/BusinessLogic/Security/BannedEmail.php
+++ b/api/BusinessLogic/Security/BannedEmail.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 1/27/2017
- * Time: 9:25 PM
- */
 
 namespace BusinessLogic\Security;
 
diff --git a/api/BusinessLogic/Security/BannedIp.php b/api/BusinessLogic/Security/BannedIp.php
index c6ddf46e..e34b2516 100644
--- a/api/BusinessLogic/Security/BannedIp.php
+++ b/api/BusinessLogic/Security/BannedIp.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 1/27/2017
- * Time: 9:51 PM
- */
 
 namespace BusinessLogic\Security;
 
diff --git a/api/BusinessLogic/Security/UserContextNotifications.php b/api/BusinessLogic/Security/UserContextNotifications.php
index aab70faa..9c32547c 100644
--- a/api/BusinessLogic/Security/UserContextNotifications.php
+++ b/api/BusinessLogic/Security/UserContextNotifications.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: user
- * Date: 1/19/17
- * Time: 8:51 PM
- */
 
 namespace BusinessLogic\Security;
 
diff --git a/api/BusinessLogic/Security/UserContextPreferences.php b/api/BusinessLogic/Security/UserContextPreferences.php
index 37c73e23..f860d3ec 100644
--- a/api/BusinessLogic/Security/UserContextPreferences.php
+++ b/api/BusinessLogic/Security/UserContextPreferences.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: user
- * Date: 1/19/17
- * Time: 8:49 PM
- */
 
 namespace BusinessLogic\Security;
 
diff --git a/api/BusinessLogic/Statuses/Closable.php b/api/BusinessLogic/Statuses/Closable.php
index 58c409ae..9d87efca 100644
--- a/api/BusinessLogic/Statuses/Closable.php
+++ b/api/BusinessLogic/Statuses/Closable.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/15/2017
- * Time: 9:52 PM
- */
 
 namespace BusinessLogic\Statuses;
 
diff --git a/api/BusinessLogic/Statuses/DefaultStatusForAction.php b/api/BusinessLogic/Statuses/DefaultStatusForAction.php
index ac9a7805..bfafff7c 100644
--- a/api/BusinessLogic/Statuses/DefaultStatusForAction.php
+++ b/api/BusinessLogic/Statuses/DefaultStatusForAction.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/15/2017
- * Time: 9:46 PM
- */
 
 namespace BusinessLogic\Statuses;
 
diff --git a/api/BusinessLogic/Statuses/StatusLanguage.php b/api/BusinessLogic/Statuses/StatusLanguage.php
index 181a04a0..58acc40b 100644
--- a/api/BusinessLogic/Statuses/StatusLanguage.php
+++ b/api/BusinessLogic/Statuses/StatusLanguage.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/16/2017
- * Time: 8:53 PM
- */
 
 namespace BusinessLogic\Statuses;
 
diff --git a/api/BusinessLogic/Tickets/Attachment.php b/api/BusinessLogic/Tickets/Attachment.php
index 125a8ced..295864bc 100644
--- a/api/BusinessLogic/Tickets/Attachment.php
+++ b/api/BusinessLogic/Tickets/Attachment.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 1/31/2017
- * Time: 9:31 PM
- */
 
 namespace BusinessLogic\Tickets;
 
diff --git a/api/BusinessLogic/Tickets/Autoassigner.php b/api/BusinessLogic/Tickets/Autoassigner.php
index ae9faa80..514a9dda 100644
--- a/api/BusinessLogic/Tickets/Autoassigner.php
+++ b/api/BusinessLogic/Tickets/Autoassigner.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/12/2017
- * Time: 4:54 PM
- */
 
 namespace BusinessLogic\Tickets;
 
diff --git a/api/BusinessLogic/Tickets/CustomFields/CustomFieldValidator.php b/api/BusinessLogic/Tickets/CustomFields/CustomFieldValidator.php
index 037d828e..12e1ccc7 100644
--- a/api/BusinessLogic/Tickets/CustomFields/CustomFieldValidator.php
+++ b/api/BusinessLogic/Tickets/CustomFields/CustomFieldValidator.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: cokoch
- * Date: 2/9/2017
- * Time: 12:28 PM
- */
 
 namespace BusinessLogic\Tickets\CustomFields;
 
diff --git a/api/BusinessLogic/Tickets/TicketGatewayGeneratedFields.php b/api/BusinessLogic/Tickets/TicketGatewayGeneratedFields.php
index 49f2f2ac..56c2a8b3 100644
--- a/api/BusinessLogic/Tickets/TicketGatewayGeneratedFields.php
+++ b/api/BusinessLogic/Tickets/TicketGatewayGeneratedFields.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: cokoch
- * Date: 2/13/2017
- * Time: 12:03 PM
- */
 
 namespace BusinessLogic\Tickets;
 
diff --git a/api/BusinessLogic/Tickets/TicketRetriever.php b/api/BusinessLogic/Tickets/TicketRetriever.php
index 0ff84fae..a9f4f8ec 100644
--- a/api/BusinessLogic/Tickets/TicketRetriever.php
+++ b/api/BusinessLogic/Tickets/TicketRetriever.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 1/31/2017
- * Time: 10:13 PM
- */
 
 namespace BusinessLogic\Tickets;
 
diff --git a/api/BusinessLogic/Validators.php b/api/BusinessLogic/Validators.php
index 7bfea07f..a718dfd4 100644
--- a/api/BusinessLogic/Validators.php
+++ b/api/BusinessLogic/Validators.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/6/2017
- * Time: 9:20 PM
- */
 
 namespace BusinessLogic;
 
diff --git a/api/Controllers/JsonRetriever.php b/api/Controllers/JsonRetriever.php
index 74711032..6b0810d3 100644
--- a/api/Controllers/JsonRetriever.php
+++ b/api/Controllers/JsonRetriever.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/13/2017
- * Time: 9:21 PM
- */
 
 namespace Controllers;
 
diff --git a/api/Core/Constants/CustomField.php b/api/Core/Constants/CustomField.php
index 566e1c76..6d92cfe8 100644
--- a/api/Core/Constants/CustomField.php
+++ b/api/Core/Constants/CustomField.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: cokoch
- * Date: 2/10/2017
- * Time: 12:53 PM
- */
 
 namespace Core\Constants;
 
diff --git a/api/DataAccess/Statuses/StatusGateway.php b/api/DataAccess/Statuses/StatusGateway.php
index de812784..636852b1 100644
--- a/api/DataAccess/Statuses/StatusGateway.php
+++ b/api/DataAccess/Statuses/StatusGateway.php
@@ -3,7 +3,6 @@
 namespace DataAccess\Statuses;
 
 
-use BusinessLogic\Statuses\DefaultStatusForAction;
 use BusinessLogic\Statuses\Status;
 use DataAccess\CommonDao;
 
diff --git a/api/Tests/BusinessLogic/Security/BanRetrieverTest.php b/api/Tests/BusinessLogic/Security/BanRetrieverTest.php
index fd1bf0a7..304bffa0 100644
--- a/api/Tests/BusinessLogic/Security/BanRetrieverTest.php
+++ b/api/Tests/BusinessLogic/Security/BanRetrieverTest.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/2/2017
- * Time: 9:57 PM
- */
 
 namespace Tests;
 
diff --git a/api/Tests/BusinessLogic/Tickets/CustomFields/CustomFieldValidatorTest.php b/api/Tests/BusinessLogic/Tickets/CustomFields/CustomFieldValidatorTest.php
index b9958be1..d08fde5e 100644
--- a/api/Tests/BusinessLogic/Tickets/CustomFields/CustomFieldValidatorTest.php
+++ b/api/Tests/BusinessLogic/Tickets/CustomFields/CustomFieldValidatorTest.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: cokoch
- * Date: 2/9/2017
- * Time: 12:29 PM
- */
 
 namespace BusinessLogic\Tickets\CustomFields;
 
diff --git a/api/Tests/BusinessLogic/Tickets/NewTicketValidatorTest.php b/api/Tests/BusinessLogic/Tickets/NewTicketValidatorTest.php
index 05f25c9d..f7009494 100644
--- a/api/Tests/BusinessLogic/Tickets/NewTicketValidatorTest.php
+++ b/api/Tests/BusinessLogic/Tickets/NewTicketValidatorTest.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/4/2017
- * Time: 9:32 PM
- */
 
 namespace BusinessLogic\Tickets\TicketCreatorTests;
 
diff --git a/api/Tests/BusinessLogic/Tickets/TicketCreatorTests/CreateTicketForCustomerTest.php b/api/Tests/BusinessLogic/Tickets/TicketCreatorTests/CreateTicketForCustomerTest.php
index 3a7f7086..fb8d81cc 100644
--- a/api/Tests/BusinessLogic/Tickets/TicketCreatorTests/CreateTicketForCustomerTest.php
+++ b/api/Tests/BusinessLogic/Tickets/TicketCreatorTests/CreateTicketForCustomerTest.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: Mike
- * Date: 2/12/2017
- * Time: 12:52 AM
- */
 
 namespace BusinessLogic\Tickets\TicketCreatorTests;
 
diff --git a/api/Tests/BusinessLogic/Tickets/TrackingIdGeneratorTest.php b/api/Tests/BusinessLogic/Tickets/TrackingIdGeneratorTest.php
index 15cfb484..0ef20b1f 100644
--- a/api/Tests/BusinessLogic/Tickets/TrackingIdGeneratorTest.php
+++ b/api/Tests/BusinessLogic/Tickets/TrackingIdGeneratorTest.php
@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: mkoch
- * Date: 2/11/2017
- * Time: 4:32 PM
- */
 
 namespace BusinessLogic\Tickets;
 
diff --git a/api/composer.json b/api/composer.json
index 280cb3a4..ec28061a 100644
--- a/api/composer.json
+++ b/api/composer.json
@@ -10,6 +10,7 @@
     }
   ],
   "require": {
-    "phpunit/phpunit": "5.7.9"
+    "phpunit/phpunit": "5.7.9",
+    "phpmailer/phpmailer": "^5.2"
   }
 }
diff --git a/api/composer.lock b/api/composer.lock
index 4bf817a6..4a0ae60f 100644
--- a/api/composer.lock
+++ b/api/composer.lock
@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
         "This file is @generated automatically"
     ],
-    "content-hash": "63ae3f15414ec2f99c94a87db755a1af",
+    "content-hash": "daddd21e73d89f981995c60d0188767d",
     "packages": [
         {
             "name": "doctrine/instantiator",
@@ -248,6 +248,66 @@
             ],
             "time": "2016-11-25T06:54:22+00:00"
         },
+        {
+            "name": "phpmailer/phpmailer",
+            "version": "v5.2.22",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/PHPMailer/PHPMailer.git",
+                "reference": "b18cb98131bd83103ccb26a888fdfe3177b8a663"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/PHPMailer/PHPMailer/zipball/b18cb98131bd83103ccb26a888fdfe3177b8a663",
+                "reference": "b18cb98131bd83103ccb26a888fdfe3177b8a663",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.0.0"
+            },
+            "require-dev": {
+                "phpdocumentor/phpdocumentor": "*",
+                "phpunit/phpunit": "4.7.*"
+            },
+            "suggest": {
+                "league/oauth2-google": "Needed for Google XOAUTH2 authentication"
+            },
+            "type": "library",
+            "autoload": {
+                "classmap": [
+                    "class.phpmailer.php",
+                    "class.phpmaileroauth.php",
+                    "class.phpmaileroauthgoogle.php",
+                    "class.smtp.php",
+                    "class.pop3.php",
+                    "extras/EasyPeasyICS.php",
+                    "extras/ntlm_sasl_client.php"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "LGPL-2.1"
+            ],
+            "authors": [
+                {
+                    "name": "Jim Jagielski",
+                    "email": "jimjag@gmail.com"
+                },
+                {
+                    "name": "Marcus Bointon",
+                    "email": "phpmailer@synchromedia.co.uk"
+                },
+                {
+                    "name": "Andy Prevost",
+                    "email": "codeworxtech@users.sourceforge.net"
+                },
+                {
+                    "name": "Brent R. Matzelle"
+                }
+            ],
+            "description": "PHPMailer is a full-featured email creation and transfer class for PHP",
+            "time": "2017-01-09T09:33:47+00:00"
+        },
         {
             "name": "phpspec/prophecy",
             "version": "dev-master",