Séance 9 : Mails

Installation du composant de mail

composer require symfony/mailer

Il faut ensuite configurer le serveur de mail qui sera utilisé.

Pour cela modifier le fichier .env.local (rappel: on ne modifie jamais le .env avec vos données personnelles).

Modifier la ligne :

MAILER_DSN=smtp://user:pass@smtp.example.com:port

Installation d'un outil SMTP et Webmail

Si vous ne disposez pas d'un serveur SMTP, vous pouvez en installer un fictif, via docker, qui permettra de gérer les mails en environnement de développement (notamment ne pas les envoyer réellement aux destinataires, les consulter...).

Dans votre fichier docker-compose.yml ajoutez le service suivant

    maildev:
        image: maildev/maildev
        container_name: maildev_docker_symfony
        command: bin/maildev --web 80 --smtp 1025 --hide-extensions STARTTLS
        restart: always
        ports:
            - 8081:80

Ce service ajoute deux choses :

• Le serveur smtp sur le port 1025 => Modifier le Mailer_DSN :

  Copier

  MAILER_DSN=smtp://maildev_docker_symfony:1025

• un webmail

  Ouvrir dans votre navigateur : http://127.0.0.1:8081/#/

Envoyer un mail simple

Prenons l'exemple de Symfony

// src/Controller/MailerController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mime\Email;
use Symfony\Component\Routing\Annotation\Route;

class MailerController extends AbstractController
{
    #[Route('/email')]
    public function sendEmail(MailerInterface $mailer): Response
    {
        $email = (new Email())
            ->from('hello@example.com')
            ->to('you@example.com')
            //->cc('cc@example.com')
            //->addCc('deuxiemecc@example.com')
            //->addTo('deuxiemeto@example.com')
            //->bcc('bcc@example.com')
            //->replyTo('fabien@example.com')
            //->priority(Email::PRIORITY_HIGH)
            ->subject('Time for Symfony Mailer!')
            ->text('Sending emails is fun again!')
            ->html('<p>See Twig integration for better HTML integration!</p>');

        $mailer->send($email);

        // ...
    }
}

Cet exemple ajoute une route (email), qui est associé à une méthode (sendEmail) dans le contrôleur (MailerController).

Modifiez les adresses ligne 16 (l'expéditeur) et ligne 17 (le destinataire).

Vous pourriez ajouter un ensemble d'option (cc, bcc, reply...)

• Ligne 22 : C'es le sujet de votre mail

• Ligne 23 : C'est votre email au format texte brut (sans HTML donc)

• Ligne 24 : C'est le contenu du "body" de votre mail au format HTML

A faire

Saisir le code, configurer le serveur de mail, modifier les emails et le texte.

Profiler

En mode développement, on interdit la distribution des mails réellement (on définit MAILER_DSN=null). Pour voir les mails, on peut donc utiliser le profiler (le dernier icône de la barre).

On peut voir l'ensemble des éléments du mail, le format HTML, Text, brut, l'en-tête...

Envoyer un mail au format HTML

La solution précédente est fonctionnelle, mais pas très pratique si vous souhaitez faire un long mail, ou un mail complexe, ou encore gérer de nombreuses données.

Il est donc possible de construire un email en utilisant la puissance de Twig et des templates.

// src/Controller/MailerController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\Routing\Annotation\Route;

class MailerController extends AbstractController
{
    #[Route('/email2')]
    public function sendEmail2(MailerInterface $mailer): Response
    {
      $email = (new TemplatedEmail())
              ->from('fabien@example.com')
              ->to(new Address('ryan@example.com'))
              ->subject('Thanks for signing up!')
          
              // path of the Twig template to render
              ->htmlTemplate('emails/signup.html.twig')
          
              // pass variables (name => value) to the template
              ->context([
                  'expiration_date' => new \DateTime('+7 days'),
                  'username' => 'foo',
              ])
          ;

        // ...
        $mailer->send($email);
    }
}

Dans ce deuxième exemple on créé un objet TemplatedEmail qui permet de manipuler des templates Twig.

La structure de base ne change pas (destinataires,... sujet).

• Ligne 21 : on associe un template (dans le répertoire templates, puis emails/signup.html.twig)

• Ligne 24-27 : on passe les paramètres nécessaires à notre vue (comme on le ferait depuis un contrôleur).

Le template de mail pourrait ressembler à :

{# templates/emails/signup.html.twig #}
<h1>Welcome {{ email.toName }}!</h1>

<p>
    You signed up as {{ username }} the following email:
</p>
<p><code>{{ email.to[0].address }}</code></p>

<p>
    <a href="#">Click here to activate your account</a>
    (this link is valid until {{ expiration_date|date('F jS') }})
</p>

Pour ajouter le format texte du mail on peut passer un template spécifique pour le format texte, qui va utiliser les mêmes données fournies par context.

->textTemplate('emails/signup.txt.twig')

Ce deuxième template (txt) ne devra pas contenir de balises HTML.

Tester

Tester ce second envoi d'email en format HTML et texte

Gestion des adresses emails

Dans Symfony il existe plusieurs façon de gérer les adresses emails. Vous trouverez ci-après quelques exemples.

// ...
use Symfony\Component\Mime\Address;

$email = (new Email())
    // email address as a simple string
    ->from('fabien@example.com')

    // email address as an object
    ->from(new Address('fabien@example.com'))

    // defining the email address and name as an object
    // (email clients will display the name)
    ->from(new Address('fabien@example.com', 'Fabien'))

    // defining the email address and name as a string
    // (the format must match: 'Name <email@example.com>')
    ->from(Address::create('Fabien Potencier <fabien@example.com>'))

    // ...
;

Faire un formulaire de contact

Exercice :

Créer un formulaire de contact.

• Créer un nouveau contrôleur nommé ContactController

• Ajouter une méthode index qui va se charger d'afficher un formulaire (adresse de l'expéditeur, sujet, message), vous serez le destinataire par défaut..

  • Vous pouvez créer le formulaire directement dans le template en HTML ou avec l'objet FormBuilder à votre convenance.

• Ajouter une méthode sendMail qui va se charger d'envoyer l'email en fonction des données du formulaire

  • On utilisera Request pour récupérer les données du formulaire

  • L'email sera envoyé à vous et en copie à la personne ayant complété le formulaire

  • Le champ reply sera configuré pour répondre à l'expéditeur

  • Le mail sera au format texte et HTML