Django provides wrappers for Python’s email and smtplib modules\nto simplify composing and sending email. Django’s email framework also supports\nswapping in different delivery mechanisms: you can direct email to the console\nor a file during development and an SMTP server or email service provider in\nproduction.
Le code se trouve dans le module django.core.mail.
Utilisez send_mail() pour l’envoi direct de courriels. Par exemple, pour envoyer un message en texte brut :
from 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)\nWhen additional email sending functionality is needed, use the\nEmailMessage or EmailMultiAlternatives\nclass. For example, to send a multipart email that includes both HTML and plain\ntext versions with a specific template and custom headers, you can use the\nfollowing approach:
from django.core.mail import EmailMultiAlternatives\nfrom django.template.loader import render_to_string\n\n# First, render the plain text content.\ntext_content = render_to_string(\n "templates/emails/my_email.txt",\n context={"my_variable": 42},\n)\n\n# Secondly, render the HTML content.\nhtml_content = render_to_string(\n "templates/emails/my_email.html",\n context={"my_variable": 42},\n)\n\n# Then, create a multipart email instance.\nmsg = EmailMultiAlternatives(\n subject="Subject here",\n body=text_content,\n from_email="from@example.com",\n to=["to@example.com"],\n headers={"List-Unsubscribe": "<mailto:unsub@example.com>"},\n)\n\n# Lastly, attach the HTML content to the email instance and send.\nmsg.attach_alternative(html_content, "text/html")\nmsg.send()\nNew Django projects are not configured to send email by default. Instead, email\nis printed to the console as a development aid (for projects created with\nstartproject) or results in a MailerDoesNotExist error (when the\nMAILERS setting isn’t defined).
Use the MAILERS setting to tell Django how to send email. For\nexample, to send through an SMTP server running on the local machine:
MAILERS = {\n "default": {\n "BACKEND": "django.core.mail.backends.smtp.EmailBackend",\n "OPTIONS": {\n "host": "localhost",\n },\n },\n}\nDjango abstracts the email sending process into an « email backend » class.\nMoteurs de messagerie lists the email backends that come with Django.
\nThe example above uses Django’s SMTP email backend, which sends using the standard SMTP protocol.\nThis backend is useful for many production configurations, including SMTP\nservers in your own infrastructure and most commercial email service providers\n(ESPs). There are also third-party email backends available that integrate directly with ESP\nAPIs or add other sending features.
\nDuring development or testing you often don’t want to send email at all.\nDjango’s test runner automatically overrides the\nMAILERS configuration to substitute Django’s memory email\nbackend. This prevents test cases from sending\nreal email and gives them access to the messages that would have been sent.\nConfiguration de la messagerie pour le développement discusses some other\napproaches.
Sometimes different types of email need to be sent in different ways: e.g.,\ninternal vs. external email, different SMTP servers for users in different\nregions, using different services for transactional notifications and bulk\nmarketing email, etc.
\nThe MAILERS setting can define multiple mail configurations. For\nexample:
import os\n\nMAILERS = {\n "default": {\n "BACKEND": "django.core.mail.backends.smtp.EmailBackend",\n "OPTIONS": {\n "host": "smtp.example.net",\n "use_tls": True,\n "username": os.environ["EMAIL_ACCOUNT_ID"],\n "password": os.environ["EMAIL_API_KEY"],\n },\n },\n "notifications": {\n "BACKEND": "example.third.party.EmailBackend",\n "OPTIONS": {\n "api_key": os.environ["THIRD_PARTY_API_KEY"],\n "region": "eu",\n },\n },\n "admin": {\n "BACKEND": "django.core.mail.backends.smtp.EmailBackend",\n "OPTIONS": {\n "host": "localhost",\n },\n },\n}\nThis defines three mailer configurations:
\n"default" sends through an SMTP server at smtp.example.net with a TLS\nsecured connection. It reads an account id and API key from environment\nvariables and uses them as the SMTP authentication username and password.\n(Many SMTP services use some variation of this authentication scheme.)
"notifications" sends through a hypothetical commercial email service,\nusing a third-party EmailBackend that connects directly to their API.\n(See Moteurs de tierce partie for pointers on locating real,\ncommunity maintained email backend packages.)
"admin" sends through an SMTP server running on localhost, with no\nother options required.
With this configuration, you can provide the using argument to Django’s\nemail sending functions to specify a particular\nmailer configuration:
from django.core.mail import send_mail\n\nsend_mail(\n "Account activated",\n "Congratulations, you're all ready to use our Django app!",\n "from@example.com",\n ["user@example.com"],\n using="notifications",\n)\nIf using is not specified, Django uses the mailer defined for the\n"default" configuration.
With reusable apps or Django features that send email for you, there may be an\noption to use a specific mailer configuration. For example, Django’s logging\nAdminEmailHandler allows specifying the mailer\nconfiguration in its using option.
django.core.mail provides functions for conveniently sending email, as\nwell as classes for building and sending more complex email messages with\nattachments and multiple content types.
send_mail()Lien vers cette rubrique#django.core.mail.send_mail() sends a single email message.
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.
Les paramètres suivants sont facultatifs, et s’ils sont indiqués, doivent être des arguments nommés.
\nfail_silently: A boolean, default False. If set True,\nsend_mail() will suppress some errors during sending. (The exact\nexceptions ignored depend on the email backend in use.)
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 .
using: An optional MAILERS alias to use to send the mail. If\nunspecified, the default mailer configuration will be used.
fail_silently, auth_user, auth_password, and connection are not\nallowed with the using argument.
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, auth_password and connection have the\nsame functions as in send_mail(). They must be given as keyword arguments\nif used, and are not allowed with the using argument.
The keyword argument using is an optional MAILERS alias to use\nto send the mail. If unspecified, the default mailer configuration will be\nused.
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 = (\n "Subject here",\n "Here is the message",\n "from@example.com",\n ["first@example.com", "other@example.com"],\n)\nmessage2 = (\n "Another Subject",\n "Here is another message",\n "from@example.com",\n ["second@test.com"],\n)\nsend_mass_mail((message1, message2))\nLa valeur renvoyée correspond au nombre de messages livrés avec succès.
\n\n\n\nsend_mass_mail() vs. send_mail()Lien vers cette rubrique#The main difference between send_mass_mail() and repeatedly calling\nsend_mail() is that send_mail() opens a connection to the mail\nserver each time it’s executed, while send_mass_mail() uses a single\nconnection for all of its messages. This makes send_mass_mail() slightly\nmore efficient.
send_mail() with multiple to addresses sends a single email message,\nwith john@example.com and jane@example.com both appearing in the « To: »\nfield:
send_mail(\n "Subject",\n "Message.",\n "from@example.com",\n ["john@example.com", "jane@example.com"],\n)\nsend_mass_mail() sends a separate message per datatuple element, so\njohn@example.com and jane@example.com each receive their own email:
datatuple = (\n ("Subject", "Message.", "from@example.com", ["john@example.com"]),\n ("Subject", "Message.", "from@example.com", ["jane@example.com"]),\n)\nsend_mass_mail(datatuple)\nmail_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 .
The keyword argument using is an optional MAILERS alias to use\nto send the mail. If unspecified, the default mailer configuration will be\nused.
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.
The keyword argument using is an optional MAILERS alias to use\nto send the mail. If unspecified, the default mailer configuration will be\nused.
EmailMessageLien 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.
La classe EmailMessage est initialisée avec les paramètres suivants. Tous les paramètres sont facultatifs et peuvent être définis à tout moment précédant l’appel à la méthode send().
Les quatre premiers paramètres peuvent être transmis en tant qu’arguments positionnels ou nommés, mais ils doivent être transmis dans cet ordre s’ils sont transmis comme paramètres positionnels :
\nsubject: la ligne sujet du courriel.
body: le texte du corps. Cela doit être un message texte brut.
from_email: The sender’s address. Both fred@example.com and\n"Fred" <fred@example.com> forms are supported (see\nFormatting email addresses). If omitted, the\nDEFAULT_FROM_EMAIL setting is used.
to: une liste ou un tuple d’adresses de destination.
Les paramètres suivants, s’ils sont indiqués, doivent être des arguments nommés :
\ncc: une liste ou un tuple d’adresses de destination utilisées dans l’en-tête « Cc » lors de l’envoi du courriel.
bcc: A list or tuple of addresses used for blind carbon copies when\nsending the email.
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.
attachments : une liste de pièces jointes à placer dans le message. Chacune peut être une instance de MIMEPart ou de EmailAttachment, ou un tuple avec attributs (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.
connection: An email backend instance.\nThis parameter is ignored when using\nsend_messages().
Par exemple :
\nfrom django.core.mail import EmailMessage\n\nemail = EmailMessage(\n subject="Hello",\n body="Body goes here",\n from_email="from@example.com",\n to=["to1@example.com", "to2@example.com"],\n bcc=["bcc@example.com"],\n reply_to=["another@example.com"],\n headers={"Message-ID": "foo"},\n)\nLa classe possède les méthodes suivantes :
\nSends the message. Returns 1 if the message was sent successfully,\notherwise 0. (An empty list of recipients returns 0 – it will\nnot raise an exception.)
The optional using keyword argument specifies a MAILERS\nalias to use to send the mail. If not given, the default mailer\nconfiguration will be used.
If a deprecated connection was specified when the email was\nconstructed, that connection will be used. Providing both a connection\nand using will raise an error.
If the deprecated keyword argument fail_silently is True,\ncertain backend-dependent exceptions while sending the message will be\nignored. Providing both fail_silently and using will raise an\nerror.
Construit et renvoie un objet Python email.message.EmailMessage représentant le message à envoyer.
The keyword argument policy allows specifying the set of rules for\nupdating and serializing the representation of the message. It must be\nan email.policy.Policy object. Defaults to\nemail.policy.default. In certain cases you may want to use\nSMTP, SMTPUTF8 or a custom\npolicy. For example, the SMTP email backend uses the SMTP policy\nto ensure \\r\\n line endings as required by the SMTP protocol.
Si vous aviez un besoin d’étendre un jour la classe EmailMessage de Django, il est probable que vous surchargiez cette méthode pour placer le contenu souhaité dans l’objet Python EmailMessage.
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.
Crée une nouvelle pièce jointe et l’ajoute au message. Il y a deux façons d’appeler attach():
Il est possible de passer trois paramètres : 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, content peut être une instance django.core.mail.EmailMessage, ou une instance email.message.EmailMessage ou email.message.Message de Python.
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.
Ou, pour les pièces jointes demandant des en-têtes ou paramètres supplémentaires, vous pouvez passer à attach() un seul objet Python MIMEPart. Il sera directement joint au message résultant. Par exemple, pour joindre une image intégrée avec un Content-ID:
import email.utils\nfrom email.message import MIMEPart\nfrom django.core.mail import EmailMultiAlternatives\n\nmessage = EmailMultiAlternatives(...)\nimage_data_bytes = ... # Load image as bytes\n\n# Create a random Content-ID, including angle brackets\ncid = email.utils.make_msgid()\ninline_image = email.message.MIMEPart()\ninline_image.set_content(\n image_data_bytes,\n maintype="image",\n subtype="png", # or "jpeg", etc. depending on the image type\n disposition="inline",\n cid=cid,\n)\nmessage.attach(inline_image)\n# Refer to Content-ID in HTML without angle brackets\nmessage.attach_alternative(f'… <img src="cid:{cid[1:-1]}"> …', "text/html")\nLa documentation Python de email.contentmanager.set_content() décrit les arguments pris en charge pour MIMEPart.set_content().
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 :
\nmessage.attach_file("/images/weather_map.png")\nPour les types MIME commençant par text/, les données binaires sont traitées comme pour attach().
Un tuple nommé pour stocker les pièces jointes d’un courriel.
\nLe tuple nommé possède les index suivants :
\nfilename
content
mimetype
Il peut être utile d’inclure plusieurs versions du contenu d’un courriel. L’exemple classique est d’envoyer à la fois les versions texte et HTML d’un message Avec la bibliothèque de messagerie de Django, cela est rendu possible par la classe EmailMultiAlternatives.
Une sous-classe de EmailMessage qui permet des versions supplémentaires du corps du message du courriel via la méthode attach_alternative(). Cette classe hérite directement de toutes les méthodes de EmailMessage (y compris l’initialisation de la classe).
Une liste de tuples nommés EmailAlternative. Ceci est particulièrement utile dans les tests :
self.assertEqual(len(msg.alternatives), 1)\nself.assertEqual(msg.alternatives[0].content, html_content)\nself.assertEqual(msg.alternatives[0].mimetype, "text/html")\nLes alternatives ne devraient être ajoutées que par la méthode attach_alternative(), ou passées directement dans le constructeur.
Ajoute une représentation alternative du corps du message dans le courriel.
\nPar exemple, pour envoyer une combinaison de texte et de HTML, vous pourriez écrire :
\nfrom django.core.mail import EmailMultiAlternatives\n\nsubject = "hello"\nfrom_email = "from@example.com"\nto = "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()\nRenvoie une valeur booléenne indiquant si la valeur text fournie est contenue dans le corps body du courriel ou dans toutes les alternatives liées avec le type MIME text/*.
Cela peut être utile lors de tests de courriels. Par exemple :
\ndef test_contains_email_content(self):\n subject = "Hello World"\n from_email = "from@example.com"\n to = "to@example.com"\n msg = EmailMultiAlternatives(subject, "I am content.", from_email, [to])\n msg.attach_alternative("<p>I am content.</p>", "text/html")\n\n self.assertIs(msg.body_contains("I am content"), True)\n self.assertIs(msg.body_contains("<p>I am content.</p>"), False)\nUn tuple nommé pour stocker les versions alternatives du contenu d’un courriel.
\nLe tuple nommé possède les index suivants :
\ncontent
mimetype
Par 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()\nAny public website that can send email will eventually be targeted by attempts\nto abuse it for spam, phishing, or other malicious content. While a complete\ndiscussion of vulnerabilities in sending email is beyond the scope of Django’s\ndocumentation, there are many references available on the web. Two good\nstarting points are:
\nPrinceton University’s guidance on preventing email abuse in web forms.\nAlthough this is an internal reference for users of Princeton’s Drupal Site\nBuilder, nearly all of its advice applies equally to sites built with Django\n(or any web framework).
OWASP’s Email Validation and Verification in Identity Systems Cheat Sheet.\nThis primarily covers using email in authentication contexts. While many of\nits recommendations are handled by django.contrib.auth and other\nDjango features, items like rate limiting and securing email change workflows\nare the developer’s responsibility.
Thinking through how email might be abused (and taking steps to mitigate it) is\nespecially important if your site can send to unverified addresses. Features\nlike newsletter sign-up, contact forms that cc or auto-reply to the sender, and\n« share this page » can be attractive targets.
\nEmail addresses allow a « friendly » display name alongside the user@domain\naddress. For example, you could include your company name in the\nDEFAULT_FROM_EMAIL setting:
DEFAULT_FROM_EMAIL = '"Example, Inc." <contact@example.com>'\nThe double quotes around "Example, Inc." are needed so the comma isn’t read\nas separating two different addresses. A fixed address, written out by hand as\nin the example above, is safe, but composing one from variable parts\n(especially untrusted input) needs more care.
Email address headers have complex syntax rules (much like HTML or SQL), so\nconstructing them by combining strings creates an injection vulnerability. Even\nif you’ve validated the format of email, an\nattacker could exploit the name portion to inject additional addresses.
To avoid this, always use a well-tested library specifically meant to format\nemail addresses, like Python’s email.headerregistry.Address class (the\nreplacement for the legacy formataddr() function, which does\nnot support internationalized domain names).
For example, to include a user’s full name when sending them email (where\nuser is an instance of the default User model):
from django.core.mail import send_mail\nfrom email.headerregistry import Address\n\n\ndef send_mail_to_user(user, subject, body, from_email=None):\n # Safely create an email address with the user's name.\n # (addr_spec is the technical term for the user@domain address.)\n address = Address(\n display_name=user.get_full_name(),\n addr_spec=user.email,\n )\n send_mail(subject, body, from_email, [address])\nDjango’s built-in email backends support using\nAddress objects directly in any address field,\nas shown here. So do many custom and third-party email backends. But if this\ncauses a TypeError or other problem with a particular backend, use\nstr(address) to convert the object to a safe, properly formatted string.
Email header injection is a security exploit in which an attacker\nmanipulates email headers to change the intended sender or recipients, subject,\nor potentially even the entire visible message body.
\nOne type of header injection exploits address header syntax. You are\nresponsible for preventing this when constructing email addresses from\nuser-supplied input, as described in Formatting email addresses above.
\nAnother (perhaps better understood) attack, CRLF injection, uses carriage\nreturn and line feed characters to insert additional headers into the email.\nDjango prevents this by raising a ValueError if those characters appear\nin any header field when trying to send the message.
Django’s CRLF protection relies on using Python’s modern\nEmailPolicy in Django’s EmailMessage.message().\nCustom email backends that don’t call that function, or that call it with the\nlegacy compat32 policy, are responsible for implementing\ntheir own CRLF injection prevention.
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.
\nThere are two ways to tell an email backend to reuse a connection. Both involve\nobtaining an email backend instance from mail.mailers and using the\nbackend’s API.
The first approach is to use the backend’s send_messages() method. This\ntakes a list of EmailMessage (or subclass) instances, and sends them\nall using that single connection.
For example, if you have a function called get_notification_emails() that\nreturns a list of EmailMessage objects representing some periodic\nemail you wish to send out, you could send these emails using a single call to\nsend_messages():
from django.core import mail\n\nemail_list = get_notification_emails()\n# Use the default mailer. You could substitute\n# mail.mailers["alias"] for a specific mailer.\nbackend = mail.mailers.default\nbackend.send_messages(email_list)\nIn this example, the call to send_messages() opens a connection on the\nbackend, sends the list of messages, and then closes the connection again.\n(This is how send_mass_mail() is implemented.)
The second approach is to use the open() and close() methods on the\nemail backend to manually control the connection. send_messages() will not\nopen or close the connection if it is already open, so if you\nmanually open the connection, you can control when it is closed. For example:
from django.core import mail\n\n# Use the "notifications" mailer configuration.\nbackend = mail.mailers["notifications"]\n\n# Manually open the connection.\nbackend.open()\n\n# Construct an email message. (Passing None as the third argument\n# uses settings.DEFAULT_FROM_EMAIL as the "From:" address.)\nemail1 = mail.EmailMessage("Hi", "Message", None, ["to1@example.com"])\n# Send the email. The connection was already open, so send_messages()\n# leaves it open after sending.\nbackend.send_messages([email1])\n\n# Construct and send two more messages. The connection is still open.\nemail2 = mail.EmailMessage("Hi", "Message", None, ["to2@example.com"])\nemail3 = mail.EmailMessage("Hi", "Message", None, ["to3@example.com"])\nbackend.send_messages([email2, email3])\n\n# Because we opened it, we need to manually close the connection.\nbackend.close()\nWhen you manually open a backend’s connection, you are responsible for ensuring\nit gets closed. The example above actually has a bug: if an exception occurs\nwhile sending the messages, the connection will not be closed. This can be\nfixed with a try-finally statement, but using the backend instance as a\ncontext manager is preferable, as it automatically calls open() and\nclose() as needed.
This is equivalent to the previous example, but uses the backend as a\ncontext manager to avoid leaving the connection open\non errors:
\nfrom django.core import mail\n\n# Use mail.mailers[...] as a context manager.\nwith mail.mailers["notifications"] as backend:\n # The backend connection is automatically opened inside the context.\n email1 = mail.EmailMessage("Hi", "Message", None, ["to1@example.com"])\n backend.send_messages([email1])\n\n # The connection is still open, and is reused for the second send.\n email2 = mail.EmailMessage("Hi", "Message", None, ["to2@example.com"])\n email3 = mail.EmailMessage("Hi", "Message", None, ["to3@example.com"])\n backend.send_messages([email2, email3])\n\n# After exiting the context (either normally or because of an error),\n# the backend connection is automatically closed.\nL’envoi réel d’un courriel est géré par le moteur de messagerie.
\nDjango comes with several email backends. With the exception of the SMTP\nbackend, these are mainly useful during testing and development. If the\nbuilt-in backends don’t meet your needs there are third-party packages available. You can also subclass one of the\nbuilt-in backends to change its behavior, or even write your own email\nbackend.
\nThe SMTP email backend connects to an SMTP server to send email. To use it, set\nBACKEND to\n"django.core.mail.backends.smtp.EmailBackend".
The SMTP backend supports these OPTIONS:
"host" (required): the SMTP server hostname or IP address.
"port": the port number to connect to on the SMTP host. If omitted,\nuses the standard port for the connection protocol depending on the\n"use_tls" and "use_ssl" options: 587 for TLS, 465 for SSL,\nor 25 for an unsecured connection.
"username" and "password": set these if your server requires SMTP\nauthentication (« SMTP AUTH » credentials, sometimes called SMTP login).
Although the username is often an email address, it should not be confused\nwith default « From: » addresses. Those are defined by the\nDEFAULT_FROM_EMAIL and SERVER_EMAIL settings.
"use_tls" or "use_ssl": set one of these options to True to\nconnect to the SMTP server using a secure protocol – "use_tls" for\nexplicit TLS or "use_ssl" for SSL (implicit TLS).
"ssl_certfile" and "ssl_keyfile": if the SMTP server’s SSL/TLS\nconnection requires client certificate authentication, use these options to\nspecify the paths to a PEM-formatted certificate chain file and private key\nfile. (The key file can be omitted if the certificate file includes the\nprivate key.)
These options are not intended for use with a private certificate authority\nor self-signed SMTP server certificate. See\nPrivate and self-signed SMTP server certificates below.
\nNote that these options don’t result in checking certificate validity. They\nare passed to the underlying SSL connection. Refer to the documentation of\nPython’s ssl.SSLContext.wrap_socket() method for details on how the\ncertificate chain file and private key file are handled.
"timeout": the timeout (in seconds) for connecting to the SMTP server and\nother blocking operations. If not specified, the value is obtained from\nsocket.getdefaulttimeout(), which defaults to no timeout (None)\nmeaning SMTP operations can block indefinitely.
"fail_silently": set to True to ignore certain errors while sending\na message. All OSErrors are ignored while opening the SMTP\nconnection, and smtplib.SMTPException errors are ignored while\ncommunicating with the server. This will suppress both transient network\nglitches and also serious configuration problems. However, it does not ignore\nall errors, and problems with serializing the message will not fail\nsilently. (This option is available for backward compatibility but is not\nrecommended for typical use.)
Exemple :
\nMAILERS = {\n "default": {\n "BACKEND": "django.core.mail.backends.smtp.EmailBackend",\n "OPTIONS": {\n "host": "smtp.example.net",\n "use_tls": True,\n "username": "my-app",\n "password": os.environ["MY_APP_SMTP_PASSWORD"],\n "timeout": 10,\n },\n },\n}\nDirectly instantiating an EmailBackend class is not recommended. Use\nmailers to obtain a backend instance.
When constructed directly (without going through mailers), the SMTP\nEmailBackend class accepts the options listed above as keyword\narguments. Default values come from the corresponding, deprecated\nEMAIL_* settings. host is not required and defaults to\n"localhost", and port defaults to 25 even if use_tls or\nuse_ssl is True.
When the MAILERS setting is defined, attempting to directly\ncreate an SMTP EmailBackend will raise an AttributeError.
If the SMTP server uses an SSL certificate from a private certificate authority\n(CA), the CA’s root certificate should be added to the system CA bundle on the\nclient (where Django is running). Likewise, if the server uses a self-signed\ncertificate, it should be added to the client’s system CA bundle so it can be\ntrusted. (The SMTP backend’s "ssl_certfile" option cannot be used for CA\nroots or self-signed certificates.)
Follow platform-specific instructions for adding to the system CA bundle. If\nmodifying the system bundle is not possible or desired, an alternative is using\nOpenSSL’s SSL_CERT_FILE or SSL_CERT_DIR environment variables to\nspecify a custom certificate bundle.
For more complex scenarios, the SMTP backend can be subclassed to add root\ncertificates to its ssl_context using\nssl.SSLContext.load_verify_locations().
Instead of sending out real emails, the console backend writes the emails that\nwould be sent to the standard output. To use it, set BACKEND to "django.core.mail.backends.console.EmailBackend".
The console backend supports these OPTIONS:
"stream": a stream-like object to write to. Defaults to stdout.
"fail_silently": set to True to ignore all errors while writing the\nmessage to the stream, including errors serializing the message. (This option\nis available for backward compatibility but is not recommended.)
Ce 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.
\n\nThe file backend writes emails to a file. A new file is created for each new\nsession that is opened on this backend. To use it, set BACKEND to "django.core.mail.backends.filebased.EmailBackend".
The file backend supports these OPTIONS:
"file_path" (required): the directory to which the files are written. Can\nbe a string or a pathlib.Path object. If the directory does not\nexist, the file backend will attempt to create it.
"fail_silently": set to True to ignore all errors while writing the\nmessage to the file – including errors serializing the message – but not\nerrors related to ensuring the file path directory exists. (This option is\navailable for backward compatibility but is not recommended.)
Ce 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.
\n\nThe 'locmem' backend stores messages in a special attribute of the\ndjango.core.mail module. The outbox attribute is created when the first\nmessage is sent. It’s a list with an EmailMessage instance for each\nmessage that would be sent. Messages in the outbox are annotated with a\nsent_using attribute that identifies the MAILERS alias used to\nsend the message.
To use the in-memory backend, set BACKEND to\n"django.core.mail.backends.locmem.EmailBackend". It does not support any\nOPTIONS.
Django’s test runner automatically switches to this backend for testing.
\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.
\n\nAs the name suggests the dummy backend does nothing with your messages. To use\nit, set BACKEND to\n"django.core.mail.backends.dummy.EmailBackend". It does not support any\nOPTIONS.
Ce 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.
\nThird-party email backends are available that:
\nIntegrate directly with commercial email service providers” APIs (which often\nhave extra functionality not available through SMTP).
Offload email sending to asynchronous task queues.
Add features to other email backends, such as enforcing do-not-send lists or\nlogging sent messages.
Provide development and debugging tools, such as sandbox capture and\nin-browser email previews.
If you need to change how emails are sent you can write your own email backend.\nTo use a custom backend, set BACKEND to the Python\nimport path for your backend class and OPTIONS to\nany __init__() keyword arguments your backend supports.
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 persistante, 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.
The mailers factory in django.core.mail returns instances of email\nbackends.
You can access the mailers configured in the MAILERS setting\nthrough a dict-like object: django.core.mail.mailers:
>>> from django.core.mail import mailers\n>>> mailers["notifications"]\nIf the named key is not defined, a MailerDoesNotExist error will be\nraised. Other configuration problems will raise an InvalidMailer error.
As a shortcut, the default mailer can be accessed through\ndjango.core.mail.mailers.default:
>>> from django.core.mail import mailers\n>>> mailers.default\nThis is equivalent to mailers["default"]. If no default mailer has\nbeen configured, a MailerDoesNotExist error will be raised.
The deprecated django.core.mail.get_connection() function creates\nand returns an instance of an email backend. Its behavior depends on the\nMAILERS setting and how the function is called.
If the MAILERS setting is defined:
get_connection() with no arguments will return\nmailers.default.
get_connection(...) called with only fail_silently or other\nkeyword arguments will create an instance of\nMAILERS["default"] with any keywords added to the\ndefault mailer’s OPTIONS.
get_connection(backend, ...) with a backend import path will raise\nan error.
If the MAILERS setting is not defined:
get_connection() with no arguments will return an instance of the\nemail backend specified in EMAIL_BACKEND.
If you specify the backend argument, an instance of that backend will\nbe instantiated.
If the keyword argument fail_silently is True, certain\nbackend-dependent exceptions during the email sending process will be\nsilently ignored.
Tous les autres paramètres nommés sont directement transmis au constructeur du moteur de messagerie.
Instances of an email backend class have the following methods:
\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.
A backend instance can also be used as a context manager, which will\nautomatically call open() and close() as needed. An example is in\nSending many messages efficiently.
À 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.
\nAnother approach is to use a mocked SMTP server that receives the emails\nlocally and displays them to the terminal, but does not actually send\nanything. The aiosmtpd package provides a way to accomplish this:
\npython -m pip install "aiosmtpd >= 1.4.5"\n\npython -m aiosmtpd -n -l localhost:8025\nThis command will start a minimal SMTP server listening on port 8025 of\nlocalhost. This server prints to standard output all email headers and the\nemail body. You then only need to set an SMTP backend’s "host" and\n"port" OPTIONS accordingly. For a more\ndetailed discussion of SMTP server options, see the documentation of the\naiosmtpd module.
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