Enviar emails com Laravel
Olá, mundo!
O Laravel é um framework bem evoluído e dispõe de bibliotecas nativas para atender toda e, quase toda, regra de negócio. Quando não, se faz assim como os demais frameworks, a adoção de bibliotecas de terceiros, no caso do Laravel, através do Composer.
Imagine um Sistema, mais precisamente um CRM (Customer Relationship Management) em que dispara emails parabenizando seus clientes em seus respectivos aniversários!Através deste exemplo, chegaremos no entendimento de outras estrutura do framework, o que nos dará mais abrangência de como ele funciona.
Começamos com a criação do projeto.
composer create-project laravel/laravel email_laravel
Com o projeto criado, vamos alterar as configurações de ambiente do Laravel .env na pasta raiz do projeto.
MAIL_MAILER=smtp
MAIL_HOST=smtp.gmail.com
MAIL_PORT=465
MAIL_USERNAME=<endereço de email>
MAIL_PASSWORD=<senha do email>
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS=<endereço de email>
MAIL_FROM_NAME="${APP_NAME}"
Estamos usando uma instalação padrão do Laravel, logo temos em nossa Migration as tabelas convencionais de um projeto novo, façamos então a inclusão de uma coluna dos usuários ( na figura de clientes) com o objetivo de armazenar a data de aniversário de cada um.
php artisan make:migration add_nascdata_coluna
Criamos uma classe de migration que irá adiocionar a coluna “nascdata” na tabela users, conforme segue:
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('users', function (Blueprint $table){
$table->date('nascdata')->nullable;
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
//
}
};
Na função up() chamamos a classe Schema e apontamos para a tabela “users” para inclusção da coluna “nascdata” com padrão DATE, e valor nulo.
Criamos nosso banco de dados:
CREATE DATABASE laravel_email;
alteramos novamente nosso arquivo de variáveis de ambiente Laravel .env
DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=laravel_email DB_USERNAME=<usuário do banco de dados> DB_PASSWORD=<senha do banco de dados>
Agora executamos nossa migration.
php artisan migrate
Nosso próximo passo é alterar a classe Model do User, incluindo a coluna “nascdata” como um array de valor preenchido ($fillable) /app/Models/User.php.
<?php
namespace App\Models;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;
class User extends Authenticatable
{
use HasApiTokens, HasFactory, Notifiable;
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'name',
'email',
'password',
'nascdata',
];
/**
* The attributes that should be hidden for serialization.
*
* @var array<int, string>
*/
protected $hidden = [
'password',
'remember_token',
];
/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [
'email_verified_at' => 'datetime',
];
}
Iremos agora criar alguns usuários para nossa lista de email com a classe Seeder.
php artisan make:seeder UserSeeder
Colocaremos dois usuário fictícios para inclusão de nossa lista:
<?php
namespace Database\Seeders;
use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;
use App\Models\User;
class UserSeeder extends Seeder
{
/**
* Run the database seeds.
*
* @return void
*/
public function run()
{
$users = [
[
"name" => "Thiago Cantero",
"email" => "thiagocantero@gmail.com",
"password" => bcrypt("123456"),
"nascdata" => "2001-06-26"
],
[
"name" => "Thiago Cantero",
"email" => "thiagolaravel@gmail.com",
"password" => bcrypt("123456"),
"nascdata" => "2001-06-26"
]
];
foreach ($users as $key => $value) {
User::create($value);
}
}
}
Como o artigo foi confeccionado na data de hoje 26/06/2022), vamos colocar o mesma data e disparar o email para os endereços válidos.
Os usuários foram criados, agora precisamos criar nossa classe para enviarmos o email para nossos aniversariantes. Que será criada na pasta app/Mail/DiaNiver.php
php artisan make:mail DiaNiver
Estruturamos desta maneira:
<?php
namespace App\Mail;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
class DiaNiver extends Mailable
{
use Queueable, SerializesModels;
public $user;
/**
* Create a new message instance.
*
* @return void
*/
public function __construct($user)
{
$this->user = $user;
}
/**
* Build the message.
*
* @return $this
*/
public function build()
{
return $this->subject('Feliz Aniversário! '. $this->user->name)
->view('emails.aniversario');
}
}
Na função build(), retornamos a mensagem “Feliz Aniversário!” e concatenamos com o usuário que está no banco, e posteriormente apontamos para nossa view que trará a mensagem.
Agora precisamos criar nossa view que servirá de template para a mensagem em que enviaremos na pasta resources/views/emails/aniversario.blade.php
<h2>Olá, {{ $user->name }} Feliz Aniversário!!!</h2>
<br>
<p>Neste dia desejamos sucesso, prosperidade e muita sáude nos seus dias vindouros.</p>
Somos grato por tê-lo conosco.
Agora criaremos um script de comando para automatizar nossa tarefa.
php artisan make:command AutoDiaNiver
Façamos a seguintes alterações:
<?php
namespace App\Console\Commands;
use App\Mail\DiaNiver;
use Illuminate\Console\Command;
class AutoDiaNiver extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'auto:dianiver';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Command description';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return int
*/
public function handle()
{
$users = User::whereMonth('nascdata', date('m'))
->whereDay('nascdata', date('d'))
->get();
if ($users->count() > 0) {
foreach ($users as $user) {
Mail::to($user)->send(new DiaNiver($user));
}
}
return 0;
}
}
Na função handle() instanciamos a varíavel $user em que apontamos para a Model user, e verificamos o mês e o dia, e armazenamos em uma coleção. Logo abaixo verificamos se a contagem de usuário for maior que zero, disparamos o email.
Feita nossa classe de comando, agora iremos realizar que este comando seja executado diariamente. Façamos a seguinte alteração no app/Console/Kernel.php
<?php
namespace App\Console;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
class Kernel extends ConsoleKernel
{
/**
* Define the application's command schedule.
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
protected function schedule(Schedule $schedule)
{
$schedule->command('auto:dianiver')->daily();
}
/**
* Register the commands for the application.
*
* @return void
*/
protected function commands()
{
$this->load(__DIR__.'/Commands');
require base_path('routes/console.php');
}
}
Colocamos na função schedule(), para execução nossa classe de comando definida na assinatura dela, e que ela seja executada diariamente.
Como estou utilizando Linux, irei programar nosso gerenciador de tarefas o cron job.
crontab -e
E incluímos a seguinte linha:
* * * * * cd /caminho-do-seu-projeto && php artisan schedule:run >> /dev/null 2>&1
Vamos verificar se as mensagens foram devidamente enviadas, para tanto utilizei o mailtrap.io é um serviço para envio de mensagem em massa ou para testes.
Vamos deixar nosso email com uma cara mais agradável?
Editamos nossa view em /resources/views/emails/aniversario.blade.php
@component('mail::message')
<h2>Olá, {{ $user->name }} Feliz Aniversário!!!</h2>
<br>
<p>Neste dia desejamos sucesso, prosperidade e muita sáude nos seus dias vindouros.</p>
Somos grato por tê-lo conosco.
@endcomponent
@component('mail::button', ['url' => 'www.thiagocantero.com.br'])
@endcomponent
aqui usamos as diretivas blade para utilizarmos o template markdown do Laravel, importante também que precisamos alterar em nosso serviço dianiver.php /app/Mail/DiaNiver.php
<?php
namespace App\Mail;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
class DiaNiver extends Mailable
{
use Queueable, SerializesModels;
public $user;
/**
* Create a new message instance.
*
* @return void
*/
public function __construct($user)
{
$this->user = $user;
}
/**
* Build the message.
*
* @return $this
*/
public function build()
{
return $this->subject('Feliz Aniversário! '. $this->user->name)
->markdown('emails.aniversario');
}
}
Ao invés de apontar para propriedade view, apontamos para a propriedade markdown
Executamos nosso serviço
php artisan auto:dianiver
Ficou bem mais apresentável, não?
Podemos ainda customizar toda este template com o seguinte comando:
php artisan vendor:publish --tag=laravel-mail
Ele baixará todos os assets que compõe o template automaticamente no seu projeto.
Aqui estão todos os arquivos que compõe o template, para realizar as suas customizações. Só usar a sua criatividade.
Sucesso, até breve.
Código fonte no github.
O otimista vê oportunidade em cada dificuldade.