Netsyms
/
Mods-for-HESK-Netsyms
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

SMTP emails working with EmailSender...haven't tested attaching things though

Browse Source
remotes/upstream/api-rewrite
Mike Koch 7 years ago
parent b4dcbc9846
commit 2a145bfa3e
8 changed files with 190 additions and 75 deletions
Show Stats Download Patch File Download Diff File

1
.gitignore vendored
Unescape Escape View File

@ -1,5 +1,6 @@
# Mods for HESK-specific files
api/vendor
api/Tests/integration_test_mfh_settings.php
# HESK Files
admin/admin_suggest_articles.php

67
api/BusinessLogic/Emails/BasicEmailSender.php
Unescape Escape View File

@ -0,0 +1,67 @@
<?php
namespace BusinessLogic\Emails;
use BusinessLogic\Tickets\Attachment;
use BusinessLogic\Tickets\Ticket;
use PHPMailer;
class BasicEmailSender implements EmailSender {
function sendEmail($emailBuilder, $heskSettings, $modsForHeskSettings, $sendAsHtml) {
$mailer = new PHPMailer();
if ($heskSettings['smtp']) {
$mailer->isSMTP();
$mailer->SMTPAuth = true;
if ($heskSettings['smtp_ssl']) {
$mailer->SMTPSecure = "ssl";
} elseif ($heskSettings['smtp_tls']) {
$mailer->SMTPSecure = "tls";
}
$mailer->Host = $heskSettings['smtp_host_name'];
$mailer->Port = $heskSettings['smtp_host_port'];
$mailer->Username = $heskSettings['smtp_user'];
$mailer->Password = $heskSettings['smtp_password'];
}
$mailer->FromName = $heskSettings['noreply_name'] ? $heskSettings['noreply_name'] : '';
$mailer->From = $heskSettings['noreply_mail'];
if ($emailBuilder->to !== null) {
foreach ($emailBuilder->to as $to) {
$mailer->addAddress($to);
}
}
if ($emailBuilder->cc !== null) {
foreach ($emailBuilder->cc as $cc) {
$mailer->addCC($cc);
}
}
if ($emailBuilder->bcc !== null) {
foreach ($emailBuilder->bcc as $bcc) {
$mailer->addBCC($bcc);
}
}
$mailer->Subject = $emailBuilder->subject;
if ($sendAsHtml) {
$mailer->Body = $emailBuilder->htmlMessage;
$mailer->AltBody = $emailBuilder->message;
} else {
$mailer->Body = $emailBuilder->message;
$mailer->isHTML(false);
}
$mailer->Timeout = $heskSettings['smtp_timeout'];
if ($mailer->send()) {
return true;
}
return $mailer->ErrorInfo;
}
}

43
api/BusinessLogic/Emails/EmailBuilder.php
Unescape Escape View File

@ -3,12 +3,41 @@
namespace BusinessLogic\Emails;
use BusinessLogic\Tickets\Attachment;
class EmailBuilder {
private $to;
private $cc;
private $bcc;
private $subject;
private $message;
private $htmlMessage;
private $attachments;
/**
* @var $to string[]
*/
public $to;
/**
* @var $cc string[]
*/
public $cc;
/**
* @var $bcc string[]
*/
public $bcc;
/**
* @var $subject string
*/
public $subject;
/**
* @var $message string
*/
public $message;
/**
* @var $htmlMessage string
*/
public $htmlMessage;
/**
* @var $attachments Attachment[]
*/
public $attachments;
}

16
api/BusinessLogic/Emails/EmailSender.php
Unescape Escape View File

@ -5,21 +5,17 @@ namespace BusinessLogic\Emails;
use BusinessLogic\Tickets\Attachment;
use BusinessLogic\Tickets\Ticket;
use PHPMailer;
interface EmailSender {
/**
* Use to send emails that do NOT include ticket information
*
* @param $emailBuilder EmailBuilder
* @param $heskSettings array
* @param $modsForHeskSettings array
* @param $sendAsHtml bool
* @return bool|string true if message sent successfully, error string otherwise
*/
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);
function sendEmail($emailBuilder, $heskSettings, $modsForHeskSettings, $sendAsHtml);
}

29
api/BusinessLogic/Emails/PhpMailEmailSender.php
Unescape Escape View File

@ -1,29 +0,0 @@
<?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.
}
}

29
api/BusinessLogic/Emails/StmpEmailSender.php
Unescape Escape View File

@ -1,29 +0,0 @@
<?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.
}
}

77
api/Tests/BusinessLogic/Emails/BasicEmailSenderIntegrationTest.php
Unescape Escape View File

@ -0,0 +1,77 @@
<?php
namespace BusinessLogic\Emails;
use PHPUnit\Framework\TestCase;
class BasicEmailSenderIntegrationTest extends TestCase {
/**
* @var $emailSender BasicEmailSender;
*/
private $emailSender;
/**
* @var $heskSettings array
*/
private $heskSettings;
/**
* @var $modsForHeskSettings array
*/
private $modsForHeskSettings;
protected function setUp() {
global $hesk_settings, $modsForHesk_settings;
if (!defined('IN_SCRIPT')) {
define('IN_SCRIPT', 1);
}
require(__DIR__ . '/../../../../hesk_settings.inc.php');
require(__DIR__ . '/../../integration_test_mfh_settings.php');
$this->emailSender = new BasicEmailSender();
$this->heskSettings = $hesk_settings;
$this->modsForHeskSettings = $modsForHesk_settings;
}
function testItCanSendHtmlMail() {
//-- Arrange
//$hesk_settings['smtp'] = 0 //Uncomment this to use PHPMail
$emailBuilder = new EmailBuilder();
$emailBuilder->to = array('mfh1@mailinator.com');
$emailBuilder->cc = array('mfh2@mailinator.com');
$emailBuilder->bcc = array('mfh3@mailinator.com');
$emailBuilder->message = "Test PLAIN TEXT message";
$emailBuilder->htmlMessage = "Test <b>HTML</b> <i>message</i>";
$emailBuilder->subject = "BasicEmailSenderIntegrationTest";
//-- Act
$result = $this->emailSender->sendEmail($emailBuilder, $this->heskSettings, $this->modsForHeskSettings, true);
//-- Assert
if ($result !== true) {
$this->fail($result);
}
}
function testItCanSendPlaintextMail() {
//-- Arrange
//$hesk_settings['smtp'] = 0 //Uncomment this to use PHPMail
$emailBuilder = new EmailBuilder();
$emailBuilder->to = array('mfh1@mailinator.com');
$emailBuilder->cc = array('mfh2@mailinator.com');
$emailBuilder->bcc = array('mfh3@mailinator.com');
$emailBuilder->message = "Test PLAIN TEXT message";
$emailBuilder->subject = "BasicEmailSenderIntegrationTest";
//-- Act
$result = $this->emailSender->sendEmail($emailBuilder, $this->heskSettings, $this->modsForHeskSettings, false);
//-- Assert
if ($result !== true) {
$this->fail($result);
}
}
}

3
api/Tests/integration_test_mfh_settings.sample.php
Unescape Escape View File

@ -0,0 +1,3 @@
<?php
// Copy this file as "integration_test_mfh_settings.php" to use
//-- Integration test data for Mods for HESK settings
Write Preview
Loading…
Cancel
Save