Même si Python fournit une interface d’envoi de courriels via le module smtplib, Django propose quelques adaptateur légers supplémentaires. Ces adaptateurs sont fournis pour rendre encore plus direct l’envoi de courriels, pour faciliter le test d’envoi de courriels durant le développement et pour fournir la prise en charge sur les plates-formes qui ne peuvent pas utiliser SMTP.
Le code se trouve dans le module django.core.mail.
En deux lignes :
\nfrom django.core.mail import send_mail\n\nsend_mail(\n 'Subject here',\n 'Here is the message.',\n 'from@example.com',\n ['to@example.com'],\n fail_silently=False,\n)\nLes messages sont envoyés en utilisant l’hôte et le port indiqués dans les réglages EMAIL_HOST et EMAIL_PORT. Les réglages EMAIL_HOST_USER et EMAIL_HOST_PASSWORD, si définis, sont utilisés pour s’authentifier auprès du serveur SMTP, et les réglages EMAIL_USE_TLS et EMAIL_USE_SSL indiquent si l’utilisation d’une connexion sécurisée est nécessaire.
send_mail()Lien vers cette rubrique#Dans la plupart des cas, vous pouvez envoyer des courriels avec django.core.mail.send_mail().
Les paramètres subject, message, from_email et recipient_list sont obligatoires.
subject: une chaîne de caractères.
message: une chaîne de caractères.
from_email: une chaîne. Si None, Django utilise la valeur du réglage DEFAULT_FROM_EMAIL.
recipient_list: une liste de chaînes de caractères, chacune étant une adresse électronique. Chaque personne dans recipient_list verra les autres destinataires dans le champ « To: » du courriel.
fail_silently: une valeur booléenne. Avec la valeur False, send_mail() lève une exception smtplib.SMTPException en cas d’erreur. Consultez la liste des exceptions possibles dans la documentation de smtplib; elles sont toutes des sous-classes de SMTPException.
auth_user: le nom d’utilisateur facultatif utilisé pour s’authentifier auprès du serveur SMTP. Si ce paramètre est absent, c’est la valeur du réglage EMAIL_HOST_USER qui sera utilisée.
auth_password: le mot de passe facultatif utilisé pour s’authentifier auprès du serveur SMTP. Si ce paramètre est absent, c’est la valeur du réglage EMAIL_HOST_PASSWORD qui sera utilisée.
connection: le moteur de messagerie facultatif utilisé pour envoyer le message. Si ce paramètre est absent, c’est une instance du moteur par défaut qui sera utilisée. Consultez la documentation sur les moteurs de messagerie pour plus de détails.
html_message: si html_message est indiqué, le courriel produit sera un courriel multipart/alternative, avec message comme type de contenu text/plain et html_message comme type de contenu text/html .
La valeur renvoyée correspond au nombre de messages livrés avec succès (qui ne peut être que 0 ou 1 puisqu’elle ne peut envoyer qu’un message).
send_mass_mail()Lien vers cette rubrique#django.core.mail.send_mass_mail() est prévu pour envoyer des courriels en masse.
datatuple est un tuple dans lequel chaque élément suit le format suivant :
(subject, message, from_email, recipient_list)\nfail_silently, auth_user et auth_password jouent le même rôle que dans send_mail().
Chaque élément de datatuple produit un courriel séparé. Comme dans send_mail(), les destinataires de la même recipient_list verront les autres adresses dans le champ « To: » des courriels.
Par exemple, le code suivant envoie deux messages différents à deux ensembles différents de destinataires ; cependant, une seule connexion est ouverte vers le serveur de messagerie :
\nmessage1 = ('Subject here', 'Here is the message', 'from@example.com', ['first@example.com', 'other@example.com'])\nmessage2 = ('Another Subject', 'Here is another message', 'from@example.com', ['second@test.com'])\nsend_mass_mail((message1, message2), fail_silently=False)\nLa valeur renvoyée correspond au nombre de messages livrés avec succès.
\nsend_mass_mail() vs. send_mail()Lien vers cette rubrique#La différence principale entre send_mass_mail() et send_mail() est que send_mail() ouvre une connexion vers le serveur de messagerie lors de chaque exécution, alors que send_mass_mail() utilise une seule connexion pour tous ses messages. send_mass_mail() est donc un peu plus efficace.
mail_admins()Lien vers cette rubrique#django.core.mail.mail_admins() est un raccourci pour envoyer un courriel aux administrateurs du site, tels qu’ils apparaissent dans le réglage ADMINS.
mail_admins() préfixe le sujet avec la valeur du réglage EMAIL_SUBJECT_PREFIX (« [Django] » par défaut).
L’en-tête « From: » du courriel correspond à la valeur du réglage SERVER_EMAIL.
Cette méthode existe par commodité et pour une meilleure lisibilité.
\nSi html_message est indiqué, le courriel produit sera un courriel multipart/alternative, avec message comme type de contenu text/plain et html_message comme type de contenu text/html .
mail_managers()Lien vers cette rubrique#django.core.mail.mail_managers() est équivalent à mail_admins(), excepté le fait qu’il envoie un courriel aux gestionnaires du site tels que définis dans le réglage MANAGERS.
Ceci envoie un courriel unique à john@example.com et jane@example.com, les deux apparaissant dans le champ « To: » :
\nsend_mail(\n 'Subject',\n 'Message.',\n 'from@example.com',\n ['john@example.com', 'jane@example.com'],\n)\nCeci envoie un courriel à john@example.com et jane@example.com, les deux recevant un courriel séparé :
\ndatatuple = (\n ('Subject', 'Message.', 'from@example.com', ['john@example.com']),\n ('Subject', 'Message.', 'from@example.com', ['jane@example.com']),\n)\nsend_mass_mail(datatuple)\nL”injection d’en-têtes est une faille de sécurité dans laquelle un attaquant insère des en-têtes de courriel supplémentaires pour contrôler les champs « To: » et « From: » des courriels que vos scripts produisent.
\nLes fonctions de messagerie de Django décrites ci-dessus protègent toutes contre l’injection d’en-têtes en interdisant les sauts de ligne dans les valeurs d’en-têtes. Si l’un des paramètres subject, from_email ou recipient_list contient un saut de ligne (que ce soit du style Unix, Windows ou Mac), la fonction de messagerie (par ex. send_mail()) lève une exception django.core.mail.BadHeaderError (une sous-classe de ValueError) et de ce fait, n’envoie pas le courriel. Il est de votre responsabilité de valider toutes les données avant de les transmettre aux fonctions de messagerie.
Si un message contient des en-têtes en début de chaîne, les en-têtes seront affichés en première partie du contenu du courriel.
Voici un exemple de vue qui récupère les valeurs subject, message et from_email à partir de données POST de la requête, envoie cela à admin@example.com et redirige vers « /contact/thanks/ » quand c’est fait :
from django.core.mail import BadHeaderError, send_mail\nfrom django.http import HttpResponse, HttpResponseRedirect\n\ndef send_email(request):\n subject = request.POST.get('subject', '')\n message = request.POST.get('message', '')\n from_email = request.POST.get('from_email', '')\n if subject and message and from_email:\n try:\n send_mail(subject, message, from_email, ['admin@example.com'])\n except BadHeaderError:\n return HttpResponse('Invalid header found.')\n return HttpResponseRedirect('/contact/thanks/')\n else:\n # In reality we'd use a form class\n # to get proper validation errors.\n return HttpResponse('Make sure all fields are entered and valid.')\nEmailMessageLien vers cette rubrique#Les fonctions send_mail() et send_mass_mail() de Django sont en réalité de légers adaptateurs qui utilisent la classe EmailMessage.
Seule une partie des fonctionnalités de la classe EmailMessage sont exposées par send_mail() et les autres fonctions adaptatrices liées. Si vous voulez utiliser des fonctionnalités avancées, telles que les destinataires en copie cachée, les fichiers joints ou les courriels multi-parties, vous devrez créer directement des instances de EmailMessage.
EmailMessage est responsable de créer le courriel lui-même. Le moteur de messagerie est ensuite responsable d’envoyer le courriel.
Par commodité, EmailMessage propose une méthode send() pour envoyer un courriel unique. Si vous devez envoyer plusieurs messages, l’API du moteur de messagerie offre une alternative.
EmailMessageLien vers cette rubrique#La classe EmailMessage est initialisée avec les paramètres suivants (dans l’ordre donné, si des paramètres positionnels sont utilisés). Tous les paramètres sont facultatifs et peuvent être définis à tout moment précédant l’appel à la méthode send().
subject: la ligne sujet du courriel.
body: le texte du corps. Cela doit être un message texte brut.
from_email: l’adresse de l’expéditeur. Les deux formes fred@example.com et "Fred" <fred@example.com> sont acceptées. Si le paramètre est absent, c’est le réglage DEFAULT_FROM_EMAIL qui est utilisé.
to: une liste ou un tuple d’adresses de destination.
bcc: une liste ou un tuple d’adresses à placer dans l’en-tête « Bcc » au moment d’envoyer le courriel.
connection: une instance de moteur de messagerie. Utilisez ce paramètre si vous voulez utiliser la même connexion pour plusieurs messages. Si ce paramètre est absent, une nouvelle connexion est initiée lorsque send() est appelée.
attachments: une liste de pièces jointes à placer dans le message. Elles peuvent être soit des instances de MIMEBase, soit des triplets (nom de fichier, contenu, type mime).
headers: un dictionnaire d’en-têtes à ajouter au message. Les clés sont les noms d’en-têtes, les valeurs sont les valeurs d’en-têtes. C’est à l’appelant de s’assurer que les noms et les valeurs d’en-têtes soient dans un format correct pour les courriels. L’attribut correspondant est extra_headers.
cc: une liste ou un tuple d’adresses de destination utilisées dans l’en-tête « Cc » lors de l’envoi du courriel.
reply_to: une liste ou un tuple d’adresses de destination utilisées dans l’en-tête « reply_to » lors de l’envoi du courriel.
Par exemple :
\nfrom django.core.mail import EmailMessage\n\nemail = EmailMessage(\n 'Hello',\n 'Body goes here',\n 'from@example.com',\n ['to1@example.com', 'to2@example.com'],\n ['bcc@example.com'],\n reply_to=['another@example.com'],\n headers={'Message-ID': 'foo'},\n)\nLa classe possède les méthodes suivantes :
\nsend(fail_silently=False) envoie le message. Si une connexion a été indiquée au moment où le courriel a été construit, c’est cette connexion qui sera utilisée. Sinon, c’est une instance du moteur par défaut qui sera utilisée. Si le paramètre nommé fail_silently vaut True, les exceptions générées lors de l’envoi du message seront ignorées. Une liste de destinataires vide ne génère pas d’exception. Cette fonction renvoie 1 si le message a été envoyé avec succès, sinon 0.
message() construit un objet django.core.mail.SafeMIMEText (une sous-classe de la classe Python MIMEText) ou un objet django.core.mail.SafeMIMEMultipart contenant le message à envoyer. S’il vous arrivait de devoir étendre la classe EmailMessage, il sera probablement nécessaire de surcharger cette méthode pour pouvoir placer le contenu souhaité dans l’objet MIME.
recipients() renvoie une liste de tous les destinataires du message, quel que soit le champ où ils se trouvent (to, cc ou bcc). C’est aussi une méthode qu’il peut être utile de surcharger lors de l’écriture d’une sous-classe, car le serveur SMTP doit recevoir la liste complète des destinataires au moment de l’envoi du message. Si vous ajoutez une autre façon d’indiquer les destinataires dans votre classe, ceux-ci doivent aussi être renvoyés par cette méthode.
attach() crée une nouvelle pièce jointe et l’ajoute au message. Il y a deux façons d’appeler attach():
Vous pouvez lui passer un seul paramètre qui est une instance de MIMEBase. Elle sera directement insérée dans le message résultant.
Il est aussi possible de passer trois paramètres à attach(): filename, content et mimetype. filename est le nom de la pièce jointe tel qu’il apparaîtra dans le courriel, content contient les données qui formeront la pièce jointe et mimetype est le type MIME facultatif de la pièce jointe. Si vous omettez mimetype, le type de contenu MIME sera déduit du nom de fichier de la pièce jointe.
Par exemple :
\nmessage.attach('design.png', img_data, 'image/png')\nSi vous indiquez message/rfc822 comme mimetype, la méthode accepte aussi les classes django.core.mail.EmailMessage et email.message.Message.
Pour un mimetype commençant par text/, le contenu attendu est une chaîne. Les données binaires sont décodées en utilisant UTF-8 et en cas d’échec, le type MIME sera transformé en application/octet-stream et les données seront jointes telles quelles.
De plus, les pièces jointes message/rfc822 ne sont plus codées en base64, ce qui contrevient à la RFC 2046 Section 5.2.1 et qui peut poser des problèmes d’affichage des pièces jointes dans Evolution et Thunderbird.
\nattach_file() crée une nouvelle pièce jointe à partir d’un fichier du système de fichiers. Appelez-la avec le chemin du fichier à joindre et, facultativement, le type MIME à utiliser pour ce fichier. Si vous omettez le type MIME, il sera déduit du nom de fichier. Voici comment l’utiliser :
message.attach_file('/images/weather_map.png')\nPour les types MIME commençant par text/, les données binaires sont traitées comme pour attach().
Il peut être utile d’inclure plusieurs versions d’un contenu dans un courriel ; l’exemple classique est d’envoyer à la fois des versions texte brut et HTML d’un message. Avec la bibliothèque de messagerie de Django, vous pouvez le faire en utilisant la classe EmailMultiAlternatives. Cette sous-classe de EmailMessage possède une méthode attach_alternative() pour inclure des versions supplémentaires du corps d’un message dans le courriel. Toutes les autres méthodes (y compris l’initialisation de la classe) sont directement héritées de EmailMessage.
Pour envoyer une combinaison de texte et de HTML, vous pourriez écrire :
\nfrom django.core.mail import EmailMultiAlternatives\n\nsubject, from_email, to = 'hello', 'from@example.com', 'to@example.com'\ntext_content = 'This is an important message.'\nhtml_content = '<p>This is an <strong>important</strong> message.</p>'\nmsg = EmailMultiAlternatives(subject, text_content, from_email, [to])\nmsg.attach_alternative(html_content, "text/html")\nmsg.send()\nPar défaut, le type MIME du paramètre body d’un EmailMessage est "text/plain". Il est recommandé de le laisser tel quel, car il garantit que tout destinataire sera capable de lire le courriel, quel que soit son client de messagerie. Cependant, si vous savez que vos destinataires savent gérer un autre type de contenu, vous pouvez utiliser l’attribut content_subtype de la classe EmailMessage pour modifier le type de contenu principal. Le type primaire sera toujours "text", mais vous pouvez modifier le sous-type. Par exemple :
msg = EmailMessage(subject, html_content, from_email, [to])\nmsg.content_subtype = "html" # Main content is now text/html\nmsg.send()\nL’envoi réel d’un courriel est géré par le moteur de messagerie.
\nLa classe du moteur de messagerie possède les méthodes suivantes :
\nopen() instancie une connexion persistante d’envoi de messages.
close() ferme la connexion actuelle vers le système d’envoi de messages.
send_messages(email_messages) envoie une liste d’objets EmailMessage. Si la connexion n’est pas ouverte, cet appel ouvrira implicitement la connexion, puis la fermera à la fin de l’opération. Si la connexion est déjà ouverte, elle sera conservée ouverte après l’envoi des messages.
Il peut aussi être utilisé comme gestionnaire de contexte, ce qui appellera automatiquement les méthodes open() et close() nécessaires :
from django.core import mail\n\nwith mail.get_connection() as connection:\n mail.EmailMessage(\n subject1, body1, from1, [to1],\n connection=connection,\n ).send()\n mail.EmailMessage(\n subject2, body2, from2, [to2],\n connection=connection,\n ).send()\nLa fonction get_connection() de django.core.mail renvoie une instance utilisable du moteur de messagerie.
Par défaut, une appel à get_connection() renvoie une instance du moteur de messagerie indiqué dans EMAIL_BACKEND. Si vous indiquez le paramètre backend, une instance de ce moteur sera créée.
Le paramètre fail_silently contrôle la gestion d’erreurs dans le moteur. Si fail_silently vaut True, les exceptions survenant durant le processus d’envoi de messages seront ignorées en silence.
Tous les autres paramètres sont directement transmis au constructeur du moteur de messagerie.
\nDjango est livré avec plusieurs moteurs de messagerie. À l’exception du moteur SMTP (moteur par défaut), ces moteurs ne sont utiles que pour les tests et le développement. Si vous avez des contraintes particulières dans l’envoi de messages, vous pouvez écrire votre propre moteur de messagerie.
\nC’est le moteur par défaut. Les courriels seront envoyés par un serveur SMTP.
\nLa valeur de chaque paramètre est récupérée à partir du réglage correspondant si le paramètre vaut None:
host: EMAIL_HOST
port: EMAIL_PORT
username: EMAIL_HOST_USER
password: EMAIL_HOST_PASSWORD
use_tls: EMAIL_USE_TLS
use_ssl: EMAIL_USE_SSL
timeout: EMAIL_TIMEOUT
ssl_keyfile: EMAIL_SSL_KEYFILE
ssl_certfile: EMAIL_SSL_CERTFILE
Le moteur SMTP est la configuration par défaut héritée par Django. Si vous voulez la définir explicitement, mettez ce qui suit dans vos réglages :
\nEMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'\nSi elle n’est pas indiquée, la valeur par défaut de timeout correspondra à la valeur fournie par socket.getdefaulttimeout() dont la valeur par défaut est None (pas d’expiration).
Au lieu d’envoyer vraiment des courriels, le moteur console ne fait qu’afficher sur la sortie standard les courriels qui auraient dû être envoyés. Par défaut, le moteur console écrit dans stdout. Vous pouvez utiliser un autre objet de type flux en indiquant le paramètre stream au moment de construire la connexion.
Pour utiliser ce moteur, mettez ce qui suit dans vos réglages :
\nEMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'\nCe moteur n’est pas conçu pour être utilisé en production, il n’est fourni que par commodité et destiné à être utilisé durant le développement.
\nLe moteur fichier écrit les courriels dans un fichier. Un nouveau fichier est créé pour chaque nouvelle session ouverte avec ce moteur. Le répertoire dans lequel les fichiers sont écrits correspond soit au réglage EMAIL_FILE_PATH, soit au mot-clé file_path transmis lors de la création de la connexion avec get_connection().
Pour utiliser ce moteur, mettez ce qui suit dans vos réglages :
\nEMAIL_BACKEND = 'django.core.mail.backends.filebased.EmailBackend'\nEMAIL_FILE_PATH = '/tmp/app-messages' # change this to a proper location\nCe moteur n’est pas conçu pour être utilisé en production, il n’est fourni que par commodité et destiné à être utilisé durant le développement.
\nLe moteur 'locmem' stocke les messages dans un attribut spécial du module django.core.mail. L’attribut outbox est créé au moment de l’envoi du premier message. C’est une liste contenant une instance de EmailMessage pour chaque message qui aurait été envoyé.
Pour utiliser ce moteur, mettez ce qui suit dans vos réglages :
\nEMAIL_BACKEND = 'django.core.mail.backends.locmem.EmailBackend'\nCe moteur n’est pas conçu pour être utilisé en production, il n’est fourni que par commodité et destiné à être utilisé durant le développement et les tests.
\nL’exécuteur de tests de Django utilise automatiquement ce moteur pour les tests.
\nComme son nom l’indique, le moteur bidon (« dummy ») ne fait rien des messages reçus. Pour définir ce moteur, mettez ce qui suit dans vos réglages :
\nEMAIL_BACKEND = 'django.core.mail.backends.dummy.EmailBackend'\nCe moteur n’est pas conçu pour être utilisé en production, il n’est fourni que par commodité et destiné à être utilisé durant le développement.
\nSi vous devez modifier la façon dont les courriels sont envoyés, vous pouvez écrire votre propre moteur de messagerie. Le réglage EMAIL_BACKEND de votre fichier de réglages contiendra alors le chemin d’importation Python vers votre classe de moteur.
Les moteurs de messagerie personnalisés doivent hériter de BaseEmailBackend qui se trouve dans le module django.core.mail.backends.base. Un moteur de messagerie personnalisé doit implémenter la méthode send_messages(email_messages). Celle-ci reçoit une liste d’instances EmailMessage et renvoie le nombre de message délivrés avec succès. Si votre moteur contient la notion de session ou connexion persistente, vous devriez aussi implémenter les méthodes open() et close(). Référez-vous à smtp.EmailBackend pour une implémentation de référence.
L’établissement et la fermeture d’une connexion SMTP (ou de toute autre connexion réseau, en fait) est un processus coûteux. Si vous avez beaucoup de courriels à envoyer, il est logique de recycler une connexion SMTP plutôt que de créer puis détruire une connexion lors de chaque envoi de message.
\nIl existe deux manières d’indiquer à un moteur de messagerie qu’il doit réutiliser une connexion.
\nPremièrement, vous pouvez utiliser la méthode send_messages(). Celle-ci accepte une liste d’instances EmailMessage (ou de ses sous-classes) et les envoie tous en utilisant une même connexion.
Par exemple, si vous aviez une fonction appelée get_notification_email() qui renvoie une liste d’objets EmailMessage représentant des courriels que vous souhaitez envoyer périodiquement, vous pourriez envoyer ces courriels en utilisant un seul appel à send_messages:
from django.core import mail\nconnection = mail.get_connection() # Use default email connection\nmessages = get_notification_email()\nconnection.send_messages(messages)\nDans cet exemple, l’appel à send_messages() ouvre une connexion au moteur, envoie la liste des messages et ferme à nouveau la connexion.
La seconde approche est d’utiliser les méthodes open() et close() du moteur de messagerie pour contrôler manuellement la connexion. send_messages() n’ouvre ou ne ferme pas manuellement de connexion si il y en a déjà une ouverte, ce qui fait qu’en ouvrant manuellement la connexion, vous contrôlez aussi quand elle sera fermée. Par exemple :
from django.core import mail\nconnection = mail.get_connection()\n\n# Manually open the connection\nconnection.open()\n\n# Construct an email message that uses the connection\nemail1 = mail.EmailMessage(\n 'Hello',\n 'Body goes here',\n 'from@example.com',\n ['to1@example.com'],\n connection=connection,\n)\nemail1.send() # Send the email\n\n# Construct two more messages\nemail2 = mail.EmailMessage(\n 'Hello',\n 'Body goes here',\n 'from@example.com',\n ['to2@example.com'],\n)\nemail3 = mail.EmailMessage(\n 'Hello',\n 'Body goes here',\n 'from@example.com',\n ['to3@example.com'],\n)\n\n# Send the two emails in a single call -\nconnection.send_messages([email2, email3])\n# The connection was already open so send_messages() doesn't close it.\n# We need to manually close the connection.\nconnection.close()\nÀ certains moments, vous ne voulez absolument pas que que Django envoie des courriels. Par exemple, pendant le développement d’un site Web, vous ne voulez certainement pas envoyer des milliers de courriels, mais vous voulez peut-être valider que ces courriels seraient envoyés aux bonnes personnes et aux bonnes conditions, et que leur contenu est correct.
\nLa manière la plus simple de configurer la messagerie électronique lors du développement local est d’utiliser le moteur de messagerie console. Ce moteur redirige tous les courriels vers la sortie standard stdout, ce qui permet d’inspecter leur contenu.
Le moteur de messagerie fichier peut aussi être utile durant le développement ; ce moteur redirige le contenu de chaque connexion SMTP dans un fichier qui peut ensuite être examiné à souhait.
\nUne autre approche est d’utiliser un serveur SMTP « stupide » qui reçoit localement les courriels et les affiche dans le terminal, mais n’envoie rien plus loin. Le paquet aiosmtpd propose une manière de faire cela :
\npython -m pip install aiosmtpd\n\npython -m aiosmtpd -n -l localhost:8025\nCette commande lance un serveur SMTP minimal écoutant sur le port 8025 de localhost. Ce serveur affiche sur la sortie standard tous les en-têtes des courriels ainsi que leur corps. Il ne vous reste plus qu’à définir adéquatement les réglages EMAIL_HOST et EMAIL_PORT. Pour une discussion plus détaillée au sujet des options de serveur SMTP, consultez la documentation du module aiosmtpd.
Pour plus d’informations sur les tests unitaires impliquant l’envoi de courriels par votre application, consultez la section Services de messagerie de la documentation sur les tests.
\n