No vídeo anterior, nos deparamos com um problema onde a variável de ambiente chamada "MAILER_DSN" não foi encontrada:
EnvNotFoundException > InvalidArgumentException
The controller for URI "/series/create" is not callable: Environment variable not found: "MAILER_DSN".
Já estudamos sobre variáveis de ambiente em treinamentos anteriores. Vamos relembrar?
Abrimos o projeto e na raiz, temos um arquivo .env que vai ter algumas opções padrão de variáveis de ambiente. Também temos um arquivo .env.local que vai ter as opções do nosso ambiente local de desenvolvimento.
Quando analisamos o .env, no final do arquivo, temos um exemplo em forma de comentário sobre um MAILER_DSN que manda para null.
.env:
# …
###> symfony/mailer ###
MAILER_DSN=null:
###< symfony/mailer ###
Isso significa enviar os e-mails para lugar nenhum e serão ignorados.
Logo, vamos copiar a linha sobre MAILER_DSN e colá-la sem # no .env.local. Afinal, as variáveis de ambiente que só devem existir no ambiente local devem adicionar no arquivo .env.local.
.env.local:
DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
MAILER_DSN=null:
Após definir o MAILER_DSN como valor nulo, vamos acessar novamente a página do formulário de criação de séries no navegador.
http://localhost:8123/series/create
Novamente vamos tentar criar uma nova série, adicionando as seguintes informações e clicando no botão "Adicionar" ao final da página.
- Nome: Nova série
- Qtd Temporadas: 5
- Ep. por Temporada: 6
A nossa série foi criada e cadastrada no banco de dados.
Série "Nova Série" adicionada com sucesso.
Com isso, o código $this->mailer->send($email) em "src > Controller > SeriesController.php" foi chamado.
Nosso mailer envia e-mails utilizando algum transportador de e-mails. Assim, ao receber essa mensagem, a envia de alguma forma.
Porém, em .env.local, dizemos para o mailer se conectar ao null://null, ou seja, não vai enviar o e-mail a lugar nenhum.
Ignorar os e-mails pode ser útil em um ambiente de testes onde não queremos mandar e-mails. Mas, no nosso cenário, queremos visualizá-los.
Transportadores
Para visualizar e-mail, vamos ler a documentação do Symfony sobre e-mails com mailer.
No nosso caso, a instalação do mailer não é necessária, pois estamos utilizando a versão fullstack (completa) do Symfony.
Por isso, vamos direto para o tópico de "transport setup", onde informa que os e-mails são enviados através de transports (transportadores).
Um dos transportadores é o SMTP, um protocolo de envio de e-mails. Com SMTP, conseguimos nos conectar a basicamente qualquer servidor.
Outras opções que já vêm instaladas por padrão são:
- sendmail - acessar o binário do sistema operacional;
- native - acessar a função do PHP que também acessa a sendmail.
Caso queiramos um transporte mais rebuscado, podemos instalar transporte de terceiros, como Amazon SES, transporte do Gmail, entre outras opções.
Vamos utilizar o transportador SMTP já que não necessita instalação. Mas, para onde vamos mandar esse e-mail?
Poderíamos abrir uma conta no Gmail e pegar os detalhes do servidor. Porém, vamos utilizar um serviço ideal para o ambiente de desenvolvimento, o Mailtrap.
Mailtrap
No navegador, vamos acessar a nossa conta no site do Mailtrap.
O Mailtrap é um serviço para testar e-mails.
Vamos configurar o servidor do Mailtrap como nosso servidor SMTP, ou seja, estaríamos enviando e-mails através do serviço do Mailtrap.
Porém, o Mailtrap mantem o e-mail para no inbox (caixa de entrada) para que consigamos visualizá-lo, independentemente do destinatário (para quem enviamos o e-mail).
Desse modo, podemos visualizar o layout do e-mail, verificar os textos alternativos e averiguar problemas.
Esse serviço tem algumas limitações: podemos ter no máximo 50 e-mails na caixa de entrada e enviar no máximo 10 e-mails dentro de um certo intervalo.
MailCatcher
Para o ambiente local, poderíamos utilizar outro serviço chamado MailCatcher.
O serviço MailCatcher é instalado na máquina. Assim, todos e-mails enviados não saem da máquina, ou seja, são visualizados na nossa própria máquina.
Porém, esse serviço normalmente utiliza docker. Com isso, temos um contêiner do PHP e outro contêiner com o MailCatcher.
Para não adicionar o conhecimento sobre docker como pré-requisito desse curso, preferimos utilizar a versão online com o Mailtrap.
Porém, se tivéssemos respondido "Sim" quando o Symfony perguntou se queríamos adicionar configurações de docker no primeiro curso sobre o framework, o MailCatcher já viria configurado - o que ajudaria muito.
Utilizando Mailtrap e SMTP
Lembre-se de acessar o Mailtrap e criar uma conta.
Em seguida, acesse sua caixa de entrada chamada "My Inbox" na parte de inboxes. Por padrão, você já terá uma inbox, mas pode criar outras também.
Na página de inboxes de uma conta pessoal da Mailtrap, podemos acessar outras partes do site pela lateral esquerda e visualizamos os projetos de inbox na parte direita.
Em "Inboxes > My Inbox", temos as informações de como conectar ao servidor de SMTP na aba "SMTP Settings".
Dentro de "SMTP Settings", em "Integrations", podemos escolher fazer a conexão através de cURL ou várias outras integrações. Vamos escolher "Symfony 5+".
Agora, temos o código com o MAILER_DSN necessário para configurar nosso mailer.
MAILER_DSN=smtp://a61b0f382eef3a:5d7013d8c3e134@smtp.mailtrap.io:2525?encryption=tls&auth_mode=login
Vamos copiar o trecho acima e colá-lo em .env.local, substituindo o MAILER_DSN igual a nulo.
.env.local:
DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
MAILER_DSN=smtp://a61b0f382eef3a:5d7013d8c3e134@smtp.mailtrap.io:2525?encryption=tls&auth_mode=login
Para entender melhor o que esse código significa, vamos voltar para a documentação do Symfony.
Quando utilizamos o SMTP, precisamos configurar o MAILER_DSN no formato exemplificado na documentação sobre e-mails no tópico "Using Built-in Transports":
Exemplo:
smtp://user:pass@smtp.example.com:25
Nos devemos informar o smtp que é o transport que estamos utilizando, seguido de dois-pontos, barra, barra. Depois, o user que é o usuário e dois-pontos novamente. Em seguida, colocamos no lugar de pass a senha do nosso servidor SMTP, arroba e o endereço do servidor SMTP substituindo smtp.example.com. Por último, colocamos dois-pontos e a porta para onde queremos enviar essas requisições ou mensagens.
Repare que o código copiado do Mailtrap tem algumas opções a mais.O Mailtrap muda a porta, adiciona detalhes de criptografia e como é a autenticação. Tudo vem configurado.
Teoricamente, isso já seria o suficiente para enviar nosso e-mail. Vamos verificar.
Verificação
No navegador, vamos abrir a listagem de séries e apagar a "Nova série", clicando no botão "X" do lado direito de seu nome.
Vamos recriá-la, clicando no botão "Adicionar" ainda na mesma página. Preenchemos o formulário de adição de nova série:
- Nome: Nova série
- Qtd Temporadas: 3
- Ep. por Temporada: 5
Após apertar no botão "Adicionar", rapidamente recebemos a mensagem de confirmação de envio.
Série "Nova série" adicionada com sucesso.
Note que a mensagem aparece muito rápido. Geralmente, envio de e-mail é mais demorado.
Quando acessamos o Mailtrap e atualizamos sua página no navegador, não temos nenhuma mensagem no nosso inbox. O que será que aconteceu?
Podemos utilizar a debug bar (barra de ferramentas para debug web) para entender o que houve. Em "app series", vamos acessar a requisição anterior a requisição POST. Para isso, clique no link que está entre parênteses, após POST.
Com isso, é aberto o Symfony Profiler. No menu vertical na lateral esquerda, vamos selecionar a opção de "e-mails".
Na metade direita da tela em "Emails", verificamos que existe um e-mail enfileirado (queued). Isto é, esse e-mail foi configurado para ser enviado depois através de um processamento assíncrono de dados.
Vamos aprender sobre processamento assíncrono nesse treinamento, mas ainda não é o momento.
Por isso, vamos interromper o servidor web pelo terminal com "Ctrl + C".
Depois, vamos ao projeto no PHP Storm e abrir "config > packages > messenger.yaml".
Nesse arquivo, vamos remover o detalhe da classe SendEmailMessage: async que está em routing.
messenger.yaml:
routing:
#apague Symfony\Component\Mailer\Messager\SendEmailMessage: async
Symfony\Component\Notifier\Message\ChatMessage: async
Symfony\Component\Notifier\Message\SmsMessage: async
Por enquanto, não precisa se preocupar com o que a linha significa.
Agora, vamos subir o servidor novamente pelo terminal para ler todas as configurações.
php -s 0.0.0.0:8123 -t public/
Vamos tentar mais uma vez criar uma série na aplicação. Para isso, vamos voltar ao navegador para fazer login no sistema novamente já que reiniciamos o servidor.
Na página inicial de listagem de séries, vamos apagar "Nova série". Para depois, adicionar a série na página de formulário de adição.
- Nome: Nova série
- Qtd Temporadas: 3
- Ep. por Temporada: 5
Repare que quando apertamos o botão "Adicionar", demora um pouca mais para aparecer a mensagem de sucesso.
Série "Nova série" adicionada com sucesso.
Quando acessamos o inbox do Mailtrap no navegador, temos um e-mail intitulado "Nova série criada" enviado a poucos segundos atrás.
Com isso, conseguimos enviar o e-mail na hora em que executamos a linha de comando $this->mailer->send($email) em SeriesController.php.
Agora, o send efetivamente envia o e-mail na hora em que é executado.
Visualizando o e-mail
Vamos agora visualizar o e-mail na inbox do Mailtrap.
No navegador, clicamos no e-mail "Nova série criada" e conseguimos visualizá-lo em uma caixa à direita que contém, de cima para baixo, título, remetente, destinatário, abas, dispositivo de visualização e o corpo do e-mail.
Na aba "HTML", na visualização para computador, vemos o corpo do e-mail com o título <h1> e parágrafo <p>.
Início do e-mail
Série criada
Série {$series->getName()} foi criada criada
Fim do e-mail
Note que existe um problema, pois o nome da série veio como {$series->getName()}. Provavelmente um erro de aspas simples, depois verificaremos.
Se seu cliente não suporta HMTL, também podemos ver a versão alternativa ao clicar na aba "Text":
Série Nova série foi criada criada
Também podemos ver o corpo do e-mail no formato "cru", ou seja, sem ser parseado, com a aba "Raw". Além de contar com análise de spam na aba "Spam Analysis".
Também podemos mudar o dispositivo de visualização do corpo do e-mail. Por exemplo, como a mensagem apareceria em um celular, tablet ou computador.
O Mailtrap é interessante por causa dessas informações que o serviço nos traz.
Enfim, podemos apagar o e-mail ao clicar no ícone de lixeira no canto superior direito.
Agora, vamos corrigir o nosso envio de e-mail.
Corrigindo a mensagem do email
Em "src > Controller > SeriesController.php", em $email, temos a mensagem em text e html.
A mensagem em text está com aspas duplas, porém, em html usamos aspas simples. Por isso, {$series->getName()} foi lido de forma errada no Mailtrap.
No PHP Storm, podemos apertar "Alt + Enter" para mostrar context actions (que ajudam a resolver erros e avisos destacados). Dentre as opções que aparecem, vamos escolher "Replace quotes" (substituir aspas).
Após a alteração da mensagem do html entre aspas duplas, vamos remover o contrabarra (\) de {\$series->getName()} para que entenda que desejamos a leitura da variável.
Também vamos retirar uma das aparições da palavra "criada" que ficou repetida.
Além disso, vamos acrescentar aspas duplas às chaves de {$series->getName()} para ficar mais fácil diferenciar o nome da série do resto do texto.
Contudo, nosso código do nome da série está dentro uma string com aspas duplas. Por isso, precisamos escapar as aspas, colocando um contrabarra antes do abre-aspas e antes do fecha-aspas.
#[Route('/series/create', name: 'app_add_series', methods: ['POST'])]
public function addSeries(Request $request): Response
{
$series &
$email &
->from(&
->to($user->getUserIdentifier())
->subject('Nova série criada')
->text("Série {$series->getName()} foi criada")
->html("<h1>Série criada</h1><p>Série \"{$series->getName()}\" foi criada</p>");
$this->mailer->send($email);
}
Após corrigir esse problema de HTML, vamos voltar para o navegador e apagar novamente a "Nova série" na página de listagem de séries do aplicativo.
Vamos adicionar uma série com as seguintes características:
- Nome: Nova série
- Qtd Temporadas: 1
- Ep. por Temporada: 1
Após clicar no botão "Adicionar" ao fim da página, esperamos um tempo até que surja a mensagem de sucesso.
Série "Nova série" adicionada com sucesso
Essa demora até o e-mail ser enviado é o motivo pelo qual a configuração sobre envio assíncrono no messenger.yaml vem habilitada por padrão. Vamos falar mais sobre essa configuração em outro vídeo.
Ainda no navegador, vamos atualizar nosso inbox do Mailtrap e visualizar o novo e-mail intitulado "Nova série criada".
Com a aba "HTML" selecionada, podemos ver nossa mensagem com o nome da série entre aspas duplas.
Início do e-mail
Série criada
Série "Nova série" foi criada
Fim do e-mail
Agora, nosso e-mail foi enviado com sucesso e de forma síncrona, ou seja, é enviado na hora em que executamos a linha de código de envio.
O Symfony mailer traz outras opções para criação de e-mails. No próximo vídeo, vamos ler sobre algumas opções interessantes na documentação que podem nos ajudar a criar e-mails.