Aller au contenu principal
Version: 0.7.3

Mail

Gestion de l'envoi de mail utilisant wp_mail.

Mail::to('user@example.com')
    ->from("client-email@wanadoo.com", "John Doe")
    ->subject("Test d'email")
    ->message("Bonjour John Doe, voici votre email de test.")
    ->send();

Méthodes

astuce

Toutes les méthodes sont statiques, permettant d'être appelées dans n'importe quel ordre à l'exception de send.
Également, toutes les méthodes sauf send retournent l'instance de la façade, permettant de chaîner les méthodes.

to(string|array $to)

Définit un ou plusieurs destinataires.

from(string $email, string $name = "")

Définit l'expéditeur.

replyTo(string $email)

Email de réponse.

subject(string $subject)

Objet du mail

message(string $message)

Définit un message. Le mail rend uniquement du texte brut. Pour utiliser de l'HTML, il faut passer par la méthode ci-dessous.

view(string $template, array $args = [])

Permet de passer l'email avec l'entête HTML et de spécifier un template Twig. Voir Email Twig pour découvrir les tags Twig facilitant l'écriture des templates d'emails.

L'utilisation de la méthode message peut annuler la prise en charge du template Twig et donc de l'HTML dans le mail.

attachment(UploadedFile|array $file)

Ajoute une pièce jointe. Si vous passez un tableau, la méthode convertit automatiquement en UploadedFile. Vous pouvez utiliser la variable $_FILES, $request->files->all() ou encore $request->files->get('input-file-name').

attachments(array $attachments)

Prend plusieurs fichiers et les intègre en pièces jointes via la méthode attachment ci-dessus.

cc(string $emails)

Prend une ou plusieurs adresses mail séparées par des virgules (,) pour les destinataires en copie.

bcc(string $emails)

De même que cc, mais pour les destinataires en copie cachée.

setHeader(string $key, string $value)

Ajout d'en-tête pour le mail. La gestion du Content-Type est gérée automatiquement avec les méthodes message ou view.

send()

Envoie le mail. Retourne un booléen en fonction de si l'envoi s'est bien passé ou non.