EmailService.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Psr\Log\LoggerInterface;
use RuntimeException;
use Zend\Mail\Header\ContentType;
use Zend\Mail\Message as MailMessage;
use Zend\Mail\Transport\TransportInterface;
use Zend\Mime\Mime;
use Zend\Mime\Message as MimeMessage;
use Zend\Mime\Part;
use Zend\Mime\Exception\InvalidArgumentException;

class EmailService {

    use Loggable;

    private $config;

    private $hooks;

    private $mailer;

    public function __construct(Config $config, PluginHooksService $hooks, TransportInterface $mailer, LoggerInterface $logger) {
        $this->config = $config;
        $this->hooks = $hooks;
        $this->mailer = $mailer;
        $this->logger = $logger;
    }

    public function send(Email $email) {
        $email = $this->hooks->trigger('prepare', 'system:email', null, $email);
        if (!$email instanceof Email) {
            $msg = "'prepare','system:email' hook handlers should return an instance of " . Email::class;
            throw new RuntimeException($msg);
        }

        $hook_params = [
            'email' => $email,
        ];

        $is_valid = $email->getFrom() && $email->getTo();
        if (!$this->hooks->trigger('validate', 'system:email', $hook_params, $is_valid)) {
            return false;
        }

        return $this->transport($email);
    }

    public function transport(Email $email) {

        $hook_params = [
            'email' => $email,
        ];

        if ($this->hooks->trigger('transport', 'system:email', $hook_params, false)) {
            return true;
        }

        // create the e-mail message
        $message = new MailMessage();
        $message->setEncoding('UTF-8');
        $message->setSender($email->getFrom());
        $message->addFrom($email->getFrom());
        $message->addTo($email->getTo());
        
        // set headers
        $headers = [
            "MIME-Version" => "1.0",
            "Content-Transfer-Encoding" => "8bit",
        ];
        $headers = array_merge($headers, $email->getHeaders());

        foreach ($headers as $name => $value) {
            // See #11018
            // Create a headerline as a concatenated string "name: value"
            // This is done to force correct class detection for each header type,
            // which influences the output of the header in the message
            $message->getHeaders()->addHeaderLine("{$name}: {$value}");
        }
        
        // add the body to the message
        try {
            $body = $this->buildMessageBody($email);
        } catch (InvalidArgumentException $e) {
            $this->logger->error($e->getMessage());
            
            return false;
        }
        
        
        $message->setBody($body);
        
        // set Subject
        $subject = elgg_strip_tags($email->getSubject());
        $subject = html_entity_decode($subject, ENT_QUOTES, 'UTF-8');
        // Sanitise subject by stripping line endings
        $subject = preg_replace("/(\r\n|\r|\n)/", " ", $subject);
        $subject = trim($subject);
        
        $message->setSubject($subject);

        // allow others to modify the $message content
        // eg. add html body, add attachments
        $message = $this->hooks->trigger('zend:message', 'system:email', $hook_params, $message);

        // fix content type header
        // @see https://github.com/Elgg/Elgg/issues/12555
        $ct = $message->getHeaders()->get('Content-Type');
        if ($ct instanceof ContentType) {
            $ct->addParameter('format', 'flowed');
        }
        
        try {
            $this->mailer->send($message);
        } catch (RuntimeException $e) {
            $this->logger->error($e->getMessage());

            return false;
        }

        return true;
    }
    
    protected function buildMessageBody(Email $email) {
        // create body
        $body = new MimeMessage();
        
        // add plain text part
        $plain_text = elgg_strip_tags($email->getBody());
        $plain_text = html_entity_decode($plain_text, ENT_QUOTES, 'UTF-8');
        $plain_text = wordwrap($plain_text);
        
        $plain_text_part = new Part($plain_text);
        $plain_text_part->setId('plaintext');
        $plain_text_part->setType(Mime::TYPE_TEXT);
        $plain_text_part->setCharset('UTF-8');
        
        $body->addPart($plain_text_part);
        
        // process attachments
        $attachments = $email->getAttachments();
        foreach ($attachments as $attachement) {
            $body->addPart($attachement);
        }
        
        return $body;
    }

}