конфиг для тестирования отправки писем

.env.example

@@ -47,12 +47,12 @@ REDIS_HOST=127.0.0.1
 REDIS_PASSWORD=null
 REDIS_PORT=6379
 
-MAIL_MAILER=log
-MAIL_SCHEME=null
-MAIL_HOST=127.0.0.1
-MAIL_PORT=2525
+MAIL_MAILER=smtp
+MAIL_HOST=mailpit
+MAIL_PORT=1025
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
 MAIL_FROM_ADDRESS="hello@example.com"
 MAIL_FROM_NAME="${APP_NAME}"
 

app/Http/Middleware/AuthenticateMagic.php

@@ -1,23 +0,0 @@
-<?php
-
-namespace App\Http\Middleware;
-//очереди для чтения нотификаций
-use Illuminate\Support\Facades\Redis;
-/**
- * Глобальный посредник аутентификации на платформе Magic для всех роутов платформы
- */
-class AuthenticateMagic
-{
-    /**
-     * Handle an incoming request.
-     *
-     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
-     */
-    public function handle(Request $request, Closure $next): Response
-    {
-                UserContext::setUserAppPermissions($user->tokens()->latest()->first()->abilities['permissions']);
-                #Гаврилов
-                //Насксолько я помню, это связано с механизмом получения нотификаций на фронте (через отдельный компонент React) на случай, если нотификации формируются на бэке и должны читаться фронтом сразу при рендеринге. Обычно, нотификации формируются после запроса с фронта, например, при fetch запросе на отправку заявки на такси и сразу же рендерятся на этой же странице после выполнения fetch запроса, но бывают ситуации, когда пользователя с бэке редиректит на другую страницу, в результате чего тяряется "контекст" нотификаций. Я как-то настраивал чтение редис очередей на любой странице, чтобы при рендеринге любой страницы сразу проверялась есть ли непрочитенная нотификация. Если есть - она читается, отображается и удаляется из очереди. Но может конкретно строка ниже связана с тестированием , уже не помню
-                Redis::setex('notifications', 60, 123);
-                return $next($request);
-            } else {

app/Mail/BaseMailerObj.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Mail;
+
+/**
+ * Базовый класс объекта параметров отправляемого мэджиком писем
+ */
+class BaseMailerObj
+{
+  public function __construct(
+    public array $to,               //адресаты письма
+    public string $subject,         //тема письма
+    public string $body,            //основной текст письма
+    public string $appName,         //кто будет в копии
+    public array $copy = [],        //шапка письма, например, для заголовка
+    public ?string $header = '',    //подвал письма, например для технической информации
+    public ?string $footer = '',    //название приложения назмещается под названием платформы Magic в футере письма
+    public string $mailLayout = 'mail\mailer_default',    //используемый blade шаблон для отправки
+  ){
+  }
+
+
+  #Гаврилов
+  //УДАЛИ ЕСЛИ НЕ ПОНАДОБИТСЯ
+  // /**
+  //  * Фабричный метод для создания экземпляра родительского класса
+  //  *
+  //  * @param [type] $to
+  //  * @param [type] $subject
+  //  * @param [type] $body
+  //  * @param [type] $appName
+  //  * @param array $copy
+  //  * @param string|null $header
+  //  * @param string|null $footer
+  //  * @param string $mailLayout
+  //  * @return void
+  //  */
+  // public static function create($to, $subject, $body, $appName, array $copy = [], ?string $header = '', ?string $footer = '', string $mailLayout = 'mail\mailer_default')
+  // {
+  //   return new self(
+  //     $to,
+  //     $subject,
+  //     $body,
+  //     $appName,
+  //     $copy,
+  //     $header,
+  //     $footer,
+  //     $mailLayout
+  //   );
+  // }
+}

app/Mail/Mailer.php

@@ -0,0 +1,145 @@
+<?php
+
+namespace App\Mail;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+use Illuminate\Queue\SerializesModels;
+use App\Mail\BaseMailerObj;
+
+class Mailer extends Mailable
+{
+    #Гаврилов
+    //ЗАЧЕМ ОНИ СЮДА ДОБАВИЛИСЬ? ТЕСТИРОВАЛ ОТПРАВКУ ОЧЕРЕДЕЙ? УДАЛИ ЕСЛИ НЕ НУЖНЫ ОТСЮДА И ИЗ USE
+    use Queueable, SerializesModels;
+
+    /**
+     * @var array данные для письма
+     */
+    public $mailData;
+    /**
+     * @var string имя blade шаблона
+     */
+    public $mailLayout;
+    /**
+     * @var string название приложения, которое отправляет сообщение
+     */
+    public $appName;
+    
+
+    /**
+     * Конструктор
+     *
+     * @param array $to - адресаты письма
+     * @param string $subject - тема письма
+     * @param string $body - основной текст письма
+     * @param array $copy - кто будет в копии
+     * @param string $header - шапка письма, например, для заголовка
+     * @param string $footer - подвал письма, например для технической информации
+     * @param string $appName название приложения назмещается под названием платформы Magic в футере письма
+     * @param string $mailLayout используемый blade шаблон для отправки
+     */ 
+    public function __construct(BaseMailerObj $mailerObject)
+        {       
+        //Преобразуем передаваемых адресатов, добавляя им логин
+        $this->mailData['to'] = $this->addDomain($mailerObject->to);
+        //$this->mailData['to'] = $to;
+        $this->mailData['copy'] = !empty($copy) ? $this->addDomain($mailerObject->copy) : [];
+        $this->mailData['subject'] = $mailerObject->subject;
+        $this->mailData['body'] = $mailerObject->body;
+        $this->mailData['header'] = $mailerObject->header;
+        $this->mailData['footer'] = $mailerObject->footer;
+        $this->checkTestEnv();
+        $this->appName = $mailerObject->appName;
+        $this->mailLayout = $mailerObject->mailLayout;
+    }
+
+
+    /**
+     * Метод корректирует свойства отправляемого письма, если среда разработки тестовая
+     *
+     * @return void
+     */
+    private function checkTestEnv()
+    {
+        //Если тестировщик аутентифицирован, берется его логин из сессии, в противном случае берется закрепленный в глобальных конфигах тестовый адрес (который разработчик указывает для своего локального тестирования сам). Можно в будущем улучшить логику с определением тестового емейла, например, передавая к api ендпоинту заголовок с тестовым емейлом, но на старте пока так 
+        // if (auth()->user()->login) {
+            if (session()->has('_auth_login')) {
+                $userLogin = session()->get('_auth_login');
+            } else {
+                $userLogin = config('app.mail_test_addressee');
+            }
+        // echo '<pre>'; var_dump($userLogin); echo'</pre>';
+        // $test = config('app.test_env');
+        // $test2 = config('app.mail_test_addressee');
+        // echo '<pre>'; var_dump($test); echo'</pre>';
+        // echo '<pre>'; var_dump($test2); echo'</pre>';
+        //}
+        // $userLogin = auth()->user()->login ? auth()->user()->login : (session()->has('_auth_login') ? session()->get('_auth_login')) : config('MAIL_TEST_ADRESSEE');
+        //Если работаем из под тестовой среды
+        if (config('app.test_env')) {
+            //Информация для тестирования будет добавлена в футер сообщения. В нее включаем информацию об адресатах и копии, если бы письмо отправлялось на проде 
+            $testInfo = "На проде письмо отправится: " . implode(", ", $this->mailData['to']) . ". В копии: " . implode(", ", $this->mailData['copy']);
+            $this->mailData['footer'] .= $testInfo;
+            //Копию очищаем
+            $this->cc('');
+            //echo '<pre>'; var_dump(['dgavrilov@rencredit.ru']); echo'</pre>';
+            //echo '<pre>'; var_dump($this->addDomain([$userLogin])); echo'</pre>';
+            $this->to($this->addDomain([$userLogin]));
+            //$this->to(['dgavrilov@rencredit.ru']);
+        } else {
+            //ГАВРИЛОВ. ДОБАВЬ ДОМЕН К ЛОГИНАМ
+            $this->to($this->mailData['to']);
+            $this->to($this->mailData['copy']);
+        }
+    }
+
+
+    /**
+     * Хэлпер преобразует всех адресатов, добавляя им почтовый домен
+     *
+     * @param array $addresseesArr адресаты
+     * @return array
+     */
+    private function addDomain(array $addresseesArr): array
+    {
+        $domain = config('mail.mail_domain');
+
+        return array_map(function($el) use($domain) {return $el . "@" . $domain;}, $addresseesArr);
+    }
+
+
+    /**
+     * Get the message envelope.
+     */
+    public function envelope(): Envelope
+    {
+        return new Envelope(
+            subject: $this->mailData['subject'],
+        );
+    }
+
+    /**
+     * Get the message content definition.
+     */
+    public function content(): Content
+    {
+        return new Content(
+            // view: 'view.name',
+            view: $this->mailLayout,
+        );
+    }
+
+    /**
+     * Get the attachments for the message.
+     *
+     * @return array<int, \Illuminate\Mail\Mailables\Attachment>
+     */
+    public function attachments(): array
+    {
+        return [];
+    }
+}

config/app.php

@@ -119,8 +119,5 @@ return [
     */
 
     'maintenance' => [
-        'driver' => env('APP_MAINTENANCE_DRIVER', 'file'),
-        'store' => env('APP_MAINTENANCE_STORE', 'database'),
-    ],
-
+    'mail_test_addressee' => env('MAIL_TEST_ADDRESSEE'),
 ];

config/mail.php

@@ -7,14 +7,13 @@ return [
     | Default Mailer
     |--------------------------------------------------------------------------
     |
-    | This option controls the default mailer that is used to send all email
-    | messages unless another mailer is explicitly specified when sending
-    | the message. All additional mailers can be configured within the
-    | "mailers" array. Examples of each type of mailer are provided.
+    | This option controls the default mailer that is used to send any email
+    | messages sent by your application. Alternative mailers may be setup
+    | and used as needed; however, this mailer will be used by default.
     |
     */
 
-    'default' => env('MAIL_MAILER', 'log'),
+    'default' => env('MAIL_MAILER', 'smtp'),
 
     /*
     |--------------------------------------------------------------------------
@@ -25,28 +24,28 @@ return [
     | their respective settings. Several examples have been configured for
     | you and you are free to add your own as your application requires.
     |
-    | Laravel supports a variety of mail "transport" drivers that can be used
-    | when delivering an email. You may specify which one you're using for
-    | your mailers below. You may also add additional mailers if needed.
+    | Laravel supports a variety of mail "transport" drivers to be used while
+    | sending an e-mail. You will specify which one you are using for your
+    | mailers below. You are free to add additional mailers as required.
     |
     | Supported: "smtp", "sendmail", "mailgun", "ses", "ses-v2",
-    |            "postmark", "resend", "log", "array",
-    |            "failover", "roundrobin"
+    |            "postmark", "log", "array", "failover", "roundrobin"
     |
     */
 
     'mailers' => [
-
         'smtp' => [
             'transport' => 'smtp',
-            'scheme' => env('MAIL_SCHEME'),
             'url' => env('MAIL_URL'),
-            'host' => env('MAIL_HOST', '127.0.0.1'),
-            'port' => env('MAIL_PORT', 2525),
+            'host' => env('MAIL_HOST', 'smtp.mailgun.org'),
+            'port' => env('MAIL_PORT', 587),
+            // 'encryption' => env('MAIL_ENCRYPTION', 'tls'),
             'username' => env('MAIL_USERNAME'),
             'password' => env('MAIL_PASSWORD'),
             'timeout' => null,
-            'local_domain' => env('MAIL_EHLO_DOMAIN', parse_url((string) env('APP_URL', 'http://localhost'), PHP_URL_HOST)),
+            //'local_domain' => env('MAIL_EHLO_DOMAIN'),
+            'auth_mode'  => null,
+            'verify_peer' => false,
         ],
 
         'ses' => [
@@ -55,14 +54,17 @@ return [
 
         'postmark' => [
             'transport' => 'postmark',
-            // 'message_stream_id' => env('POSTMARK_MESSAGE_STREAM_ID'),
+            // 'message_stream_id' => null,
             // 'client' => [
             //     'timeout' => 5,
             // ],
         ],
 
-        'resend' => [
-            'transport' => 'resend',
+        'mailgun' => [
+            'transport' => 'mailgun',
+            // 'client' => [
+            //     'timeout' => 5,
+            // ],
         ],
 
         'sendmail' => [
@@ -85,7 +87,6 @@ return [
                 'smtp',
                 'log',
             ],
-            'retry_after' => 60,
         ],
 
         'roundrobin' => [
@@ -94,9 +95,7 @@ return [
                 'ses',
                 'postmark',
             ],
-            'retry_after' => 60,
         ],
-
     ],
 
     /*
@@ -104,9 +103,9 @@ return [
     | Global "From" Address
     |--------------------------------------------------------------------------
     |
-    | You may wish for all emails sent by your application to be sent from
-    | the same address. Here you may specify a name and address that is
-    | used globally for all emails that are sent by your application.
+    | You may wish for all e-mails sent by your application to be sent from
+    | the same address. Here, you may specify a name and address that is
+    | used globally for all e-mails that are sent by your application.
     |
     */
 
@@ -115,4 +114,25 @@ return [
         'name' => env('MAIL_FROM_NAME', 'Example'),
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Markdown Mail Settings
+    |--------------------------------------------------------------------------
+    |
+    | If you are using Markdown based email rendering, you may configure your
+    | theme and component paths here, allowing you to customize the design
+    | of the emails. Or, you may simply stick with the Laravel defaults!
+    |
+    */
+
+    'markdown' => [
+        'theme' => 'default',
+
+        'paths' => [
+            resource_path('views/vendor/mail'),
+        ],
+    ],
+
+    'mail_domain' => env('MAIL_DOMAIN'),
+
 ];

config/services.php

@@ -14,12 +14,15 @@ return [
     |
     */
 
-    'postmark' => [
-        'key' => env('POSTMARK_API_KEY'),
+    'mailgun' => [
+        'domain' => env('MAILGUN_DOMAIN'),
+        'secret' => env('MAILGUN_SECRET'),
+        'endpoint' => env('MAILGUN_ENDPOINT', 'api.mailgun.net'),
+        'scheme' => 'https',
     ],
 
-    'resend' => [
-        'key' => env('RESEND_API_KEY'),
+    'postmark' => [
+        'token' => env('POSTMARK_TOKEN'),
     ],
 
     'ses' => [
@@ -28,11 +31,4 @@ return [
         'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
     ],
 
-    'slack' => [
-        'notifications' => [
-            'bot_user_oauth_token' => env('SLACK_BOT_USER_OAUTH_TOKEN'),
-            'channel' => env('SLACK_BOT_USER_DEFAULT_CHANNEL'),
-        ],
-    ],
-
 ];

resources/views/mail/mailer_default.blade.php

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title><h3>{!! $mailData['header'] !!}</h3></title>
+</head>
+<body>
+    <p style="margin: 15px 0 50px 0">{!! $mailData['body'] !!}</p>
+    <p>{!! $mailData['footer'] !!}</p>
+    <p><img width="150" height="34" alt="" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAAAiCAYAAAC9WiCBAAAAIGNIUk0AAHomAACAhAAA+gAAAIDoAAB1MAAA6mAAADqYAAAXcJy6UTwAAAAGYktHRAD/AP8A/6C9p5MAAAAJcEhZcwAACxMAAAsTAQCanBgAAAAHdElNRQfpCA4ROwLiaJtLAAAJOklEQVR42u3be4wdVR0H8M/cbbcPCuVVQJ5toRBQgfhAwSKBqAQRVMSoSIIooZJIEKMEjBGJIhQVLEgViaDhIWh9gCKg1igPUXkEEQqoRaAUbKu0S6F0t+29/vGbYefOzL13dyvsbtlvMtm7Z875zTlnfuf8fr/v70yijK6KsjoaBo9aeuXbNlJ5oxJ1Z2Y/90v4OL6CFQ11NRcMd/dGDJLC/7vgTEzVrww1/A7fG6Ts7XAWpuVkdeEuXGqUKVfD2RrWZlM2PuFinIxP03VJw3okas4f7q6OCBQV6zDcjO5C+SN4F5YMQvaJQhmLz7gDR+D54R78QFF3lkRdQ6Kh0VWTzMEF2AxPCQW7uX8ljilXrfD/rhhXUW9PHDkIuVPwEWWlgu3FjjgasXtNchHmCqWCncUCOgPbDHcHRwqKijWzoiyr9yEDV4iDcGCLe9sI5RpFaKAh4QScKhZOHq/B2QmHJoOWvWmiVvg9o03dAzB7ADLH4Tjlyc8wBTsN98AHg0Qi3Xy/jS/h2UKVxfgUbh3uvo4U5BVrMnZrU3eyUJjxHWS+VvhjrdCtvQKPZDyzt/PPwWlYlZYtxsdIrsTqoYTOmyLyirUlduhQ/x3Yt0OdY4VpaIeZwz3wwSBxnsRcNDzsTHXJtbgCG3Ae7qAuKIcxx51mxdoB23aovx0+2Ob+LjhmAM+drhx5jngk5mog0ag3uASnY0HGpozxWNV4H/pknmrr6xGhGFWYI1ZxJxn3YKtB9G0LEX3NEMq9sUpZw9bC9O8mdutB+d0fto/5DneIXQfTbIIIXGak49liI8cxYpGnFmYo+089gm/KO9sZ9XBpoe5UQTHkd8H1+Bf20PzithO748o2fevGW/F+EThsn/ZvNf4uHOUbhK9zKi+94YX4eQuZk4U5fy/2F8oFK3AffoLfp/U+mfZxFS7H8rRuguOus2j/6yyqp+N9FN9Px1uFmWLhHordBVWxHstwL36GO9E7tNc4svEt5Z3lfnwB6wrlt4lVnseReKFQbxE+n05Yvnw1Dm7Tl50xXyheq12vLsjW04ViZOXfaCFzD1yDNW1k9ogFc2quz8uwT05OFxYU2i3ExIpnduMTeFj7HbwHVwql26QwAb+oGPBNmIW/FcrXiFWfn8BrKtp/VfBZPYXy9Ti+RV+mi92okznNrl79ucwGvlYhcxZuH4TM53O/n8beOVld+FGh/q+VFatbLMo1g3juHdjrlX31Lw8yszVF7BJFLME/0onMY5KgHjJfZ1+8s1DnGVwvXkzR5HWpphw2w5dV0xV1rBW7Zx7d2vtHU0SiuIqDe0Hsdi9U9GNjcbzYrSdV3OtTbTbfJqLMUe97ZYq1rfB7ingi/bsATxbuHSb8FCJSnFa4fyseFLvV8grZM5QV4kjlqHOdyF/OwbsFnXEh/j3AMR4t/Js8VuGbOEr4XEeLpHLP/2leZ+Kzykp1Hz4nIueP4jv4b6HOUdpH3qMKhyj7RxuEM04oQJUPNleYrkeVfYbD0rbjhXNabLtQOMkZJuGXhTrrhDmtWsGHi8CgKDdvCifiRmUzd5KyUtdwSsU8DMUUnlbRr18pR9OJCE6erpibVpmLUYUTNPspDTyn2XwcKFZXkXq4SGzr+fIbNa/WC5UnepFmInUvcVIgX+cW7c3CycqBRV6xdhe7bv7+9cKnrMIE/NjGKVa3iFbz95fiDW3GcQruxl/SvzdpnwUZ8cjohpnKK7hH+EkZ7sNvRDI6wywR5ucPB/YJR/7FXNkTypgmzG/2jF31h//EC/mpUPBWuCWV3Sqa2lGZL1uodVjfK86eHbsRc7qlcmbhTjzQps13cXVh7C8axagJpZhecW+ZZqe7Nx38mkL7oh9xj1DAPB5Xdro318yPbaWZR+sTpq4dVmrva03UzNXVdfajntWajxoIJimbscc7yNwgKJjsej4tG7WoCT9nesW9pekg8/gD/thGXh3XKmf/lyof7JtQeG5mTvN9q+KG8hintVmTPrOvILPTkZ2dVJ9JGyjqykoxYSiCRjNqWp+Pelx5l1ktFKfV6ntU8GFFLFNWNpoph+WCTsgwXnu/hDA509vcf0rQCXkcobVjvEV6f2PwXMUz9xM7dCvsK0jZ7JqjcyJ/xOMgZae8IRjtKuwg/K0qgu+cFm02F+Rfsf4C/eZvR+HQF4OD17WQOVGkWtpFheOVidte1fxSxncVg4HBOu8JLivcX6M/wi5iqjI5/ZjRe7ToJRwnHMX8wPrwgTZtzlB+oUu0VoIuXFfR5s/6U0OtKI3b8Xb9ilATu9RFYodrp1gELVFk/teIvOBJIoMwR1AdvRXyhkI3HF0xp4+lc5pRLImI/C5TjqqvUP211KjC2RWTuRJvbtNmFv5ZaHOZ6mPNGc6veM4TmiOoA5Q5nQb+IyLAy4WCPlJRp5VijRdkaFXdutih6m3kDUWxNhcRbVHWc2ndS/EDPFRRZ5lg4Ec9rq4Y3GLtfRf4umZFPLhD/ZMrntMjTHGGBJ9RvXMM9KrKFU5Lx1kfgryh5gr3Vzbtna4+8fndqD86X1Od9Fyh2tnO44didRHc0N0d6i9R5o+m0HSgqSFONZyrHJFWIXvxnb5RXCHOpH9ROTWVl/WAMIkbCuUN7VGlCPeLozd/HcA4CMZ/LuYN4HkjHuPEas52iKxssc4E3QOCIT4GV2mO6KrwlDBp2+aeVVNOfq8VaZwHRWrkTZpTP3l5Vwnycb4gV7u0Jj9XCef8epHkfqP+j2mfEQvjZrwnvTL0aubu6E8ir0/nKz9/edwm8n6ni3xlVaS3VgRDFwvzuc4mgESYsFqh7GlxmK4Tdkyvh3RWxInCPOQ5nUTsII+1aLOV8LveIna2icLsPiSc+oeFMr1evylaqp/pT0Rie0+xq9XEorkhvZ/1pTdX/0qR4spwl6AgenJ19hZZg0b6/7NiIbTaOcelbWanf7dOn7lEKPSflJPRY3iFkBhapHSuZj9mufJpB0LpThQ7W77+vJdhLF02AT/q1Y4DRNqnGHldIqiG2eKoynxlpVopTn6MYQwl1MRHplURYa9I+7SKQufp/B3lGF7FmCp2pIF8hZTxW9coH14cwxhKmCy4tHuVWfHsWifynWcZ3OdpYyjg1ehA7iz8ptniy53JQqGeFCmm3wrlGsNG4H8h23sE7JXaQwAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNS0wOC0xNFQxNzo1ODo0MSswMDowML3iBaUAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjUtMDgtMTRUMTc6NTg6NDErMDA6MDDMv70ZAAAAKHRFWHRkYXRlOnRpbWVzdGFtcAAyMDI1LTA4LTE0VDE3OjU5OjAyKzAwOjAwwcrjnwAAAABJRU5ErkJggg=="></p>
+    <br><h2>{{ $appName }}</h2>
+</body>
+</html>