MailPanel.php 3.73 KB
Newer Older
Mark committed
1
<?php
Carsten Brandt committed
2 3 4 5 6
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */
Mark committed
7 8 9 10 11 12 13 14 15

namespace yii\debug\panels;

use Yii;
use yii\base\Event;
use yii\debug\models\search\Mail;
use yii\debug\Panel;
use yii\mail\BaseMailer;
use yii\helpers\FileHelper;
16
use yii\mail\MessageInterface;
Mark committed
17 18 19

/**
 * Debugger panel that collects and displays the generated emails.
20 21 22 23 24
 *
 * @property array $messages Messages. This property is read-only.
 *
 * @author Mark Jebri <mark.github@yandex.ru>
 * @since 2.0
Mark committed
25 26 27
 */
class MailPanel extends Panel
{
28 29 30 31 32 33 34 35 36
    /**
     * @var string path where all emails will be saved. should be an alias.
     */
    public $mailPath = '@runtime/debug/mail';
    /**
     * @var array current request sent messages
     */
    private $_messages = [];

37 38 39
    /**
     * @inheritdoc
     */
40 41 42 43 44
    public function init()
    {
        parent::init();
        Event::on(BaseMailer::className(), BaseMailer::EVENT_AFTER_SEND, function ($event) {

45
            /* @var $message MessageInterface */
46 47
            $message = $event->message;
            $messageData = [
48 49 50 51 52 53 54 55 56
                    'isSuccessful' => $event->isSuccessful,
                    'from' => $this->convertParams($message->getFrom()),
                    'to' => $this->convertParams($message->getTo()),
                    'reply' => $this->convertParams($message->getReplyTo()),
                    'cc' => $this->convertParams($message->getCc()),
                    'bcc' => $this->convertParams($message->getBcc()),
                    'subject' => $message->getSubject(),
                    'charset' => $message->getCharset(),
            ];
57 58 59

            // add more information when message is a SwiftMailer message
            if ($message instanceof \yii\swiftmailer\Message) {
60
                /* @var $swiftMessage \Swift_Message */
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
                $swiftMessage = $message->getSwiftMessage();

                $messageData['body'] = $swiftMessage->getBody();
                $messageData['time'] = $swiftMessage->getDate();
                $messageData['headers'] = $swiftMessage->getHeaders();

            }

            // store message as file
            $fileName = $event->sender->generateMessageFileName();
            FileHelper::createDirectory(Yii::getAlias($this->mailPath));
            file_put_contents(Yii::getAlias($this->mailPath) . '/' . $fileName, $message->toString());
            $messageData['file'] = $fileName;

            $this->_messages[] = $messageData;
76 77 78
        });
    }

79 80 81
    /**
     * @inheritdoc
     */
82 83 84 85 86
    public function getName()
    {
        return 'Mail';
    }

87 88 89
    /**
     * @inheritdoc
     */
90 91 92 93 94
    public function getSummary()
    {
        return Yii::$app->view->render('panels/mail/summary', ['panel' => $this, 'mailCount' => count($this->data)]);
    }

95 96 97
    /**
     * @inheritdoc
     */
98 99 100 101 102 103 104 105 106 107 108 109
    public function getDetail()
    {
        $searchModel = new Mail();
        $dataProvider = $searchModel->search(Yii::$app->request->get(), $this->data);

        return Yii::$app->view->render('panels/mail/detail', [
                'panel' => $this,
                'dataProvider' => $dataProvider,
                'searchModel' => $searchModel
        ]);
    }

110 111 112
    /**
     * @inheritdoc
     */
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
    public function save()
    {
        return $this->getMessages();
    }

    /**
     * Returns info about messages of current request. Each element is array holding
     * message info, such as: time, reply, bc, cc, from, to and other.
     * @return array messages
     */
    public function getMessages()
    {
        return $this->_messages;
    }

    private function convertParams($attr)
    {
        if (is_array($attr)) {
            $attr = implode(', ', array_keys($attr));
        }

        return $attr;
    }
Mark committed
136
}