App\Controller\Component\MailerComponent

Complexity

Total Complexity

4

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Test Coverage

Coverage

95.45%

Importance

Changes	3
Bugs	0	Features	1

1 Method

Rating	Name	Duplication	Size	Complexity
A	sendReportMail()	0	32	4

<?php

/**
 * Mailer component handling sending of report notification mails
 *
 * phpMyAdmin Error reporting server
 * Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright Copyright (c) phpMyAdmin project (https://www.phpmyadmin.net/)
 * @license   https://opensource.org/licenses/mit-license.php MIT License
 *
 * @see      https://www.phpmyadmin.net/
 */

namespace App\Controller\Component;

use Cake\Controller\Component;
use Cake\Core\Configure;
use Cake\Mailer\Mailer;

use function sprintf;

/**
 * Mailer component handling report notification emails.
 */
class MailerComponent extends Component
{
    /**
     * Send an email about the report to configured Email
     *
     * @param array $viewVars Array of View Variables
     *
     * @return bool if Email was sent
     */
    public function sendReportMail(array $viewVars): bool
    {
        $email = new Mailer('default');
        $emailTo = Configure::read('NotificationEmailsTo');
        $emailFrom = Configure::read('NotificationEmailsFrom');
        $emailTransport = Configure::read('NotificationEmailsTransport');

        if ($emailTransport === null) {
            return false;
        }

        if (empty($emailFrom) || empty($emailTo)) {
            return false;
        }

        $email->viewBuilder()->setLayout('default');
        $email->viewBuilder()->setTemplate('report');

        $email->setTransport($emailTransport)
            ->setViewVars($viewVars)
            ->setSubject(
                sprintf(
                    'A new report has been submitted on the Error Reporting Server: %s',
                    $viewVars['report']['id']
                )
            )
            ->setEmailFormat('html')
            ->setTo($emailTo)
            ->setFrom($emailFrom)
            ->send();

        return true;
    }
}