MboxTransport.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Mail;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Locking\LockFactory;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class MboxTransport implements \Swift_Transport
{
    private $debugFile;

    public function __construct($debugFile)
    {
        $this->debugFile = $debugFile;
    }

    public function isStarted()
    {
        return false;
    }

    public function start()
    {
    }

    public function stop()
    {
    }

    public function send(\Swift_Mime_Message $message, &$failedRecipients = null)
    {
        $message->generateId();
        // Create a mbox-like header
        $mboxFrom = $this->getReversePath($message);
        $mboxDate = strftime('%c', $message->getDate());
        $messageStr = sprintf('From %s  %s', $mboxFrom, $mboxDate) . LF;
        // Add the complete mail inclusive headers
        $messageStr .= $message->toString();
        $messageStr .= LF . LF;
        $lockFactory = GeneralUtility::makeInstance(LockFactory::class);
        $lockObject = $lockFactory->createLocker('mbox');
        $lockObject->acquire();
        // Write the mbox file
        $file = @fopen($this->debugFile, 'a');
        if (!$file) {
            $lockObject->release();
            throw new \RuntimeException(sprintf('Could not write to file "%s" when sending an email to debug transport', $this->debugFile), 1291064151);
        }
        @fwrite($file, $messageStr);
        @fclose($file);
        GeneralUtility::fixPermissions($this->debugFile);
        $lockObject->release();
        // Return every recipient as "delivered"
        $count = count((array)$message->getTo()) + count((array)$message->getCc()) + count((array)$message->getBcc());
        return $count;
    }

    private function getReversePath(\Swift_Mime_Message $message)
    {
        $return = $message->getReturnPath();
        $sender = $message->getSender();
        $from = $message->getFrom();
        $path = null;
        if (!empty($return)) {
            $path = $return;
        } elseif (!empty($sender)) {
            $keys = array_keys($sender);
            $path = array_shift($keys);
        } elseif (!empty($from)) {
            $keys = array_keys($from);
            $path = array_shift($keys);
        }
        return $path;
    }

    public function registerPlugin(\Swift_Events_EventListener $plugin)
    {
        return true;
    }
}