firefly-iii/app/Handlers/Events/AdminEventHandler.php

<?php
/**
 * AdminEventHandler.php
 * Copyright (c) 2019 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace FireflyIII\Handlers\Events;

use Exception;
use FireflyIII\Events\AdminRequestedTestMessage;
use FireflyIII\Mail\AdminTestMail;
use FireflyIII\Repositories\User\UserRepositoryInterface;
use Log;
use Mail;
use Session;

/**
 * Class AdminEventHandler.
 */
class AdminEventHandler
{
    /**
     * Sends a test message to an administrator.
     *
     * @param AdminRequestedTestMessage $event
     *
     * @return bool
     */
    public function sendTestMessage(AdminRequestedTestMessage $event): bool
    {
        /** @var UserRepositoryInterface $repository */
        $repository = app(UserRepositoryInterface::class);

        // is user even admin?
        if ($repository->hasRole($event->user, 'owner')) {
            $email     = $event->user->email;
            $ipAddress = $event->ipAddress;

            // see if user has alternative email address:
            $pref = app('preferences')->getForUser($event->user, 'remote_guard_alt_email', null);
            if (null !== $pref) {
                $email = $pref->data;
            }

            Log::debug(sprintf('Now in sendTestMessage event handler. Email is %s, IP is %s', $email, $ipAddress));
            try {
                Log::debug('Trying to send message...');
                Mail::to($email)->send(new AdminTestMail($email, $ipAddress));
                // @codeCoverageIgnoreStart
                // Laravel cannot pretend this process failed during testing.
            } catch (Exception $e) {
                Log::debug('Send message failed! :(');
                Log::error($e->getMessage());
                Log::error($e->getTraceAsString());
                Session::flash('error', 'Possible email error: ' . $e->getMessage());
            }
            // @codeCoverageIgnoreEnd
            Log::debug('If no error above this line, message was sent.');
        }

        return true;
    }
}