PHPMailer: Envio de e-mails com PHP

Introduç�o

PHPMailer � uma biblioteca para envio de emails escrita em PHP, que possui uma implementaç�o do protocolo SMTP, o que a torna independente de plataforma. Com ela, a partir de uma API de alto n�vel podemos enviar e-mails para mais de uma conta ao mesmo tempo, copiar mensagens para outras conta, CC, ou separar as mensagens em c�pia, BCC.

Al�m disso, essa biblioteca tamb�m suporta o envio de mensagens em HTML/TXT, disponibilizando ainda um modo no qual a mensagem possui mais de uma vers�o, em ambos os formatos, para clientes que n�o suportam HTML.

Uma outra vantagem dessa biblioteca � o suporte a m�ltiplos mecanismos autenticaç�o SMTP, como LOGIN, PLAIN, NTLM, CRAM-MD5 e o XOAUTH2 da Google por SSL ou TLS. Com ele tamb�m � poss�vel usar assinatura DKIM e S/MIME.

Todas essas funcionalidades est�o dispon�veis para projetos que utilizem o PHP 5.0 ou superior.

Neste conte�do veremos como enviar emails com o PHPMailer atrav�s do SMTP do Gmail, smtp.gmail.com.

Ir para o c�digo

Download e Instalaç�o

A instalaç�o do PHPMailer pode ocorrer de duas formas: pelo Composer ou realizando o download do c�digo fonte compactado na p�gina oficial do projeto no GitHub.

#PraCegoVer - Transcriç�o dos Slides Agora � s� criar um objeto do tipo PHPMailer - $mail = new \PHPMailer();

Configurar os dados de Acesso ao servidor de envio de e-mails. N�s utilizamos o smtp.gmail.com
$mail->isSMTP();
$mail->Host = 'smtp.gmail.com';
$mail->Port = 587;
$mail->SMTPSecure = 'tls';
$mail->SMTPAuth = true;
$mail->Username = 'mailcurso702@gmail.com';
$mail->Password = '';

Configurar as contas para as quais voc� deseja enviar a mensagem
$mail->setFrom('mailcurso702@gmail.com', 'Meu Nome');
$mail->addReplyTo('replyto@meusite.com', 'Meu Nome');
$mail->addAddress('samuel-vicente-moraes@outlook.com', 'Moraes');
$mail->addCC('samuel-vicente-moraes@outlook.com', 'Moraes');
$mail->addBCC('samuel-vicente-moraes@outlook.com', 'Moraes');
$mail->Subject = 'Envio de email';

Tamb�m o que voc� deseja enviar na mensagem, como HTML, texto e anexos...
$mail-> Charset = 'UTF-8';
$mail-> msgHTML("< p >Mensagem de < b >boas-vindas< /b >!< /p >");
$mail-> AltBody = 'Mensagem de boas-vindas');
$mail->addAttachment(_DIR_ .'/logo-devmedia.png');

Por fim, basta chamar a funç�o send(), que realiza o envio do e-mail
if (!$mail -> send()){
die ("Erro no envio do e-mail: {$mail -> ErrorInfo}");
}echo 'Mensagem enviada com sucesso';

Para instalar via Composer, adicione a linha "phpmailer/phpmailer": "~5.2" ao seu composer.json e ent�o utilize o comando abaixo:

composer require phpmailer/phpmailer

Se ainda n�o possui familiaridade com o composer, recomendamos o curso O que � Composer.

Tamb�m � poss�vel descompactar os arquivos da biblioteca no seu projeto, ap�s realizar o download.

Enviando emails

Ap�s ter a biblioteca inserida no projeto, devemos incluir o autoloader do PHPMailer para ter acesso �s suas classes e funç�es. Logo em seguida, devido � sua API de alto n�vel, podemos realizar algumas configuraç�es, usando para isso uma inst�ncia da classe PHPMailer e ent�o chamar a funç�o send() para disparar a mensagem atrav�s de um servidor de envio.

Um exemplo completo desse c�digo pode ser visto a seguir.


   include_once __DIR__ . '/phpmailer/PHPMailerAutoload.php';
   
   $mail = new \PHPMailer();
   $mail->isSMTP();
   $mail->Host = 'smtp.gmail.com';
   $mail->Port = 587;
   $mail->SMTPSecure = 'tls';
   $mail->SMTPAuth = true;
   $mail->Username = 'mailcurso702@gmail.com';
   $mail->Password = '';
   $mail->setFrom('mailcurso702@gmail.com', 'Meu Nome');
   $mail->addReplyTo('replyto@meusite.com', 'Meu Nome');
   $mail->addAddress('samuel-vicente-moraes@outlook.com', 'Moraes');
   $mail->addCC('samuel-vicente-moraes@outlook.com', 'Moraes');
   $mail->addBCC('samuel-vicente-moraes@outlook.com', 'Moraes');
   $mail->Subject = 'Envio de email';
   $mail->CharSet = 'UTF-8';
   $mail->msgHTML("<p>Mensagem de <b>boas-vindas</b>!</p>");
   $mail->AltBody = 'Mensagem de boas-vindas';
   $mail->addAttachment(__DIR__ . '/logo-devmedia.png');
   
   if (!$mail->send()) {
             die("Erro no envio do e-mail: {$mail->ErrorInfo}");
   }
   
   echo 'Mensagem enviada com sucesso';

Configurando o servidor de envio

As informaç�es de acesso ao servidor de envio podem mudar de acordo com o serviço escolhido. No exemplo acima estamos disparando a mensagem pelo servidor do Gmail, saiba mais sobre os passos necess�rios para autenticaç�o.

Esta documentaç�o nos orienta utilizar $mail->isSMTP(), pois usaremos autenticaç�o SMTP; $mail->Host, para que a autenticaç�o seja feita no servidor SMTP do Gmail; $mail->Port, como porta; e $mail->SMTPSecure como protocolo de autenticaç�o, al�m de $mail->SMTPAuth, visto que n�s solicitaremos a autenticaç�o por usu�rio e senha, definidos com $mail->Username e $mail->Password.

Inserindo endereços de envio e recebimento

Com a funç�o $mail->setFrom() definimos o e-mail de origem da mensagem. Essa funç�o recebe um segundo argumento opcional com o nome da pessoa ou entidade que est� enviando o e-mail.

Em alguns casos, exibir o e-mail de origem n�o � necess�rio, ou desejamos que as respostas caiam em uma conta diferente da utilizada para enviar a mensagem. Para isso podemos usar a funç�o $mail->addReplyTo(), para a qual informamos a conta que receber� as respostas.

O destinat�rio � definido na funç�o $mail->addAddress(), que pode ser chamada tantas vezes quanto forem necess�rias para incluir todos os destinat�rios na mensagem.

T�tulo e corpo da mensagem

A propriedade $mail->Subject recebe o t�tulo do e-mail a ser enviado. A mensagem inclu�da neste e-mail pode ser informada como String para o m�todo $mail->msgHTML(), que tamb�m pode receber a localizaç�o de um arquivo HTML como par�metro, e ainda um texto opcional pode ser usado para clientes sem suporte a HTML, atrav�s da propriedade $mail->AltBody.

Caso a mensagem enviada apresente problemas com a exibiç�o de alguns caracteres, podemos usar a propriedade $mail->CharSet para determinar codificaç�o mais adequada. Neste caso utilizamos UTF-8.

C�pia e c�pia oculta

Al�m da funç�o $mail->addAddress(), tamb�m podemos utilizar $mail->addCC(), para adicionar uma pessoa em c�pia, ou $mail->addBCC(), para incluir um endereço que n�o ter� conhecimento dos demais inclu�dos na mensagem.

Anexando arquivos

PHPMailer tamb�m suporta o envio de anexos de diferentes tipos. Para demonstrar essa funcionalidade, neste exemplo inclu�mos uma imagem contendo o logotipo da empresa. Isso pode ser realizado com a funç�o $mail->addAttachment(), que recebe como par�metro a localizaç�o do arquivo.

Depuraç�o

Apesar da API de alto n�vel do PHPMailer, que resolve boa parte dos problemas, algumas vezes precisamos testar as configuraç�es, at� que tudo esteja de acordo com o exigido pelo servidor de envio. Para auxiliar o programaç�o nesse processo podemos habilitar o modo de depuraç�o que, quando ativo, oferece mensagens adicionar sobre cada passo em segundo plano pela biblioteca.

Para isso utilizamos a propriedade $mail->SMTPDebug, que recebe valores de 0 a 3, de acordo com o n�vel de profundidade que desejamos depurar. Quanto mais alto o valor, mais detalhada ser� a mensagem de retorno.