From f99a3c501fd6ed7b4914b8d6e855489c2ce5b219 Mon Sep 17 00:00:00 2001 From: Frederic Guillot Date: Fri, 16 Oct 2015 20:50:12 -0400 Subject: Make mail transports pluggable and move integrations to plugins - Postmark: https://github.com/kanboard/plugin-postmark - Mailgun: https://github.com/kanboard/plugin-mailgun - Sendgrid: https://github.com/kanboard/plugin-sendgrid --- app/Core/Base.php | 6 +-- app/Core/EmailClient.php | 49 ------------------ app/Core/Mail/Client.php | 96 ++++++++++++++++++++++++++++++++++++ app/Core/Mail/ClientInterface.php | 24 +++++++++ app/Core/Mail/Transport/Mail.php | 57 +++++++++++++++++++++ app/Core/Mail/Transport/Sendmail.php | 25 ++++++++++ app/Core/Mail/Transport/Smtp.php | 30 +++++++++++ app/Core/Plugin/Base.php | 2 +- 8 files changed, 234 insertions(+), 55 deletions(-) delete mode 100644 app/Core/EmailClient.php create mode 100644 app/Core/Mail/Client.php create mode 100644 app/Core/Mail/ClientInterface.php create mode 100644 app/Core/Mail/Transport/Mail.php create mode 100644 app/Core/Mail/Transport/Sendmail.php create mode 100644 app/Core/Mail/Transport/Smtp.php (limited to 'app/Core') diff --git a/app/Core/Base.php b/app/Core/Base.php index 331b67e3..76723e8f 100644 --- a/app/Core/Base.php +++ b/app/Core/Base.php @@ -11,7 +11,7 @@ use Pimple\Container; * @author Frederic Guillot * * @property \Kanboard\Core\Helper $helper - * @property \Kanboard\Core\EmailClient $emailClient + * @property \Kanboard\Core\Mail\Client $emailClient * @property \Kanboard\Core\HttpClient $httpClient * @property \Kanboard\Core\Paginator $paginator * @property \Kanboard\Core\Request $request @@ -29,11 +29,7 @@ use Pimple\Container; * @property \Kanboard\Integration\GitlabWebhook $gitlabWebhook * @property \Kanboard\Integration\HipchatWebhook $hipchatWebhook * @property \Kanboard\Integration\Jabber $jabber - * @property \Kanboard\Integration\Mailgun $mailgun - * @property \Kanboard\Integration\Postmark $postmark - * @property \Kanboard\Integration\Sendgrid $sendgrid * @property \Kanboard\Integration\SlackWebhook $slackWebhook - * @property \Kanboard\Integration\Smtp $smtp * @property \Kanboard\Formatter\ProjectGanttFormatter $projectGanttFormatter * @property \Kanboard\Formatter\TaskFilterGanttFormatter $taskFilterGanttFormatter * @property \Kanboard\Formatter\TaskFilterAutoCompleteFormatter $taskFilterAutoCompleteFormatter diff --git a/app/Core/EmailClient.php b/app/Core/EmailClient.php deleted file mode 100644 index 38d6b3f1..00000000 --- a/app/Core/EmailClient.php +++ /dev/null @@ -1,49 +0,0 @@ -container['logger']->debug('Sending email to '.$email.' ('.MAIL_TRANSPORT.')'); - - $start_time = microtime(true); - $author = 'Kanboard'; - - if (Session::isOpen() && $this->userSession->isLogged()) { - $author = e('%s via Kanboard', $this->user->getFullname($this->session['user'])); - } - - switch (MAIL_TRANSPORT) { - case 'sendgrid': - $this->sendgrid->sendEmail($email, $name, $subject, $html, $author); - break; - case 'mailgun': - $this->mailgun->sendEmail($email, $name, $subject, $html, $author); - break; - case 'postmark': - $this->postmark->sendEmail($email, $name, $subject, $html, $author); - break; - default: - $this->smtp->sendEmail($email, $name, $subject, $html, $author); - } - - $this->container['logger']->debug('Email sent in '.round(microtime(true) - $start_time, 6).' seconds'); - } -} diff --git a/app/Core/Mail/Client.php b/app/Core/Mail/Client.php new file mode 100644 index 00000000..c7cfaab9 --- /dev/null +++ b/app/Core/Mail/Client.php @@ -0,0 +1,96 @@ +transports = new Container; + } + + /** + * Send a HTML email + * + * @access public + * @param string $email + * @param string $name + * @param string $subject + * @param string $html + * @return EmailClient + */ + public function send($email, $name, $subject, $html) + { + $this->container['logger']->debug('Sending email to '.$email.' ('.MAIL_TRANSPORT.')'); + + $start_time = microtime(true); + $author = 'Kanboard'; + + if ($this->userSession->isLogged()) { + $author = e('%s via Kanboard', $this->user->getFullname($this->session['user'])); + } + + $this->getTransport(MAIL_TRANSPORT)->sendEmail($email, $name, $subject, $html, $author); + + if (DEBUG) { + $this->logger->debug('Email sent in '.round(microtime(true) - $start_time, 6).' seconds'); + } + + return $this; + } + + /** + * Get mail transport instance + * + * @access public + * @param string $transport + * @return EmailClientInterface + */ + public function getTransport($transport) + { + return $this->transports[$transport]; + } + + /** + * Add a new mail transport + * + * @access public + * @param string $transport + * @param string $class + * @return EmailClient + */ + public function setTransport($transport, $class) + { + $container = $this->container; + + $this->transports[$transport] = function() use ($class, $container) { + return new $class($container); + }; + + return $this; + } +} diff --git a/app/Core/Mail/ClientInterface.php b/app/Core/Mail/ClientInterface.php new file mode 100644 index 00000000..66263a98 --- /dev/null +++ b/app/Core/Mail/ClientInterface.php @@ -0,0 +1,24 @@ +setSubject($subject) + ->setFrom(array(MAIL_FROM => $author)) + ->setBody($html, 'text/html') + ->setTo(array($email => $name)); + + Swift_Mailer::newInstance($this->getTransport())->send($message); + } + catch (Swift_TransportException $e) { + $this->logger->error($e->getMessage()); + } + } + + /** + * Get SwiftMailer transport + * + * @access protected + * @return \Swift_Transport + */ + protected function getTransport() + { + return Swift_MailTransport::newInstance(); + } +} diff --git a/app/Core/Mail/Transport/Sendmail.php b/app/Core/Mail/Transport/Sendmail.php new file mode 100644 index 00000000..849e3385 --- /dev/null +++ b/app/Core/Mail/Transport/Sendmail.php @@ -0,0 +1,25 @@ +setUsername(MAIL_SMTP_USERNAME); + $transport->setPassword(MAIL_SMTP_PASSWORD); + $transport->setEncryption(MAIL_SMTP_ENCRYPTION); + + return $transport; + } +} diff --git a/app/Core/Plugin/Base.php b/app/Core/Plugin/Base.php index d8b196e1..e38ffee8 100644 --- a/app/Core/Plugin/Base.php +++ b/app/Core/Plugin/Base.php @@ -66,7 +66,7 @@ abstract class Base extends \Kanboard\Core\Base */ public function getPluginName() { - return ucfirst(substr(get_called_class(), 7, -7)); + return ucfirst(substr(get_called_class(), 16, -7)); } /** -- cgit v1.2.3