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.
The code lives in the django.core.mail module.
Use send_mail() for straightforward email sending. For example, to send a\nplain text message:
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.\nEmail backends 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.\nConfiguring email for development 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 Third-party backends 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()Link to this heading#django.core.mail.send_mail() sends a single email message.
The subject, message, from_email and recipient_list parameters\nare required.
subject: A string.
message: A string.
from_email: A string. If None, Django will use the value of the\nDEFAULT_FROM_EMAIL setting.
recipient_list: A list of strings, each an email address. Each\nmember of recipient_list will see the other recipients in the „To:”\nfield of the email message.
The following parameters are optional, and must be given as keyword arguments\nif used.
\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: The optional username to use to authenticate to the SMTP\nserver. If this isn’t provided, Django will use the value of the\nEMAIL_HOST_USER setting.
auth_password: The optional password to use to authenticate to the\nSMTP server. If this isn’t provided, Django will use the value of the\nEMAIL_HOST_PASSWORD setting.
connection: The optional email backend to use to send the mail.\nIf unspecified, an instance of the default backend will be used.\nSee the documentation on Email backends\nfor more details.
html_message: If html_message is provided, the resulting email will\nbe a multipart/alternative email with message as the\ntext/plain content type and html_message as the\ntext/html content type.
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.
The return value will be the number of successfully delivered messages (which\ncan be 0 or 1 since it can only send one message).
send_mass_mail()Link to this heading#django.core.mail.send_mass_mail() is intended to handle mass emailing.
datatuple is a tuple in which each element is in this format:
(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.
Each separate element of datatuple results in a separate email message.\nAs in send_mail(), recipients in the same recipient_list will all see\nthe other addresses in the email messages» „To:” field.
For example, the following code would send two different messages to\ntwo different sets of recipients; however, only one connection to the\nmail server would be opened:
\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))\nThe return value will be the number of successfully delivered messages.
\n\n\n\nsend_mass_mail() vs. send_mail()Link to this heading#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()Link to this heading#django.core.mail.mail_admins() is a shortcut for sending an email to the\nsite admins, as defined in the ADMINS setting.
mail_admins() prefixes the subject with the value of the\nEMAIL_SUBJECT_PREFIX setting, which is "[Django] " by default.
The „From:” header of the email will be the value of the\nSERVER_EMAIL setting.
This method exists for convenience and readability.
\nIf html_message is provided, the resulting email will be a\nmultipart/alternative email with message as the\ntext/plain content type and html_message as the\ntext/html content type.
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()Link to this heading#django.core.mail.mail_managers() is just like mail_admins(), except it\nsends an email to the site managers, as defined in the MANAGERS\nsetting.
The keyword argument using is an optional MAILERS alias to use\nto send the mail. If unspecified, the default mailer configuration will be\nused.
EmailMessage classLink to this heading#Django’s send_mail() and send_mass_mail() functions are actually\nthin wrappers that make use of the EmailMessage class.
Not all features of the EmailMessage class are available through the\nsend_mail() and related wrapper functions. If you wish to use advanced\nfeatures, such as BCC’ed recipients, file attachments, or multi-part email,\nyou’ll need to create EmailMessage instances directly.
EmailMessage is responsible for creating the email message itself. The\nemail backend is then responsible for sending the\nemail.
For convenience, EmailMessage provides a send()\nmethod for sending a single email. If you need to send multiple messages, the\nemail backend API provides an alternative.
The EmailMessage class is initialized with the following\nparameters. All parameters are optional and can be set at any time prior\nto calling the send() method.
The first four parameters can be passed as positional or keyword arguments,\nbut must be in the given order if positional arguments are used:
\nsubject: The subject line of the email.
body: The body text. This should be a plain text message.
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: A list or tuple of recipient addresses.
The following parameters must be given as keyword arguments if used:
\ncc: A list or tuple of recipient addresses used in the „Cc” header\nwhen sending the email.
bcc: A list or tuple of addresses used for blind carbon copies when\nsending the email.
reply_to: A list or tuple of recipient addresses used in the\n„Reply-To” header when sending the email.
attachments: A list of attachments to put on the message. Each can\nbe an instance of MIMEPart or\nEmailAttachment, or a tuple with attributes\n(filename, content, mimetype).
headers: A dictionary of extra headers to put on the message. The\nkeys are the header name, values are the header values. It’s up to the\ncaller to ensure header names and values are in the correct format for\nan email message. The corresponding attribute is extra_headers.
connection: An email backend instance.\nThis parameter is ignored when using\nsend_messages().
Na przykład:
\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)\nThe class has the following methods:
\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.
Constructs and returns a Python email.message.EmailMessage\nobject representing the message to be sent.
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.
If you ever need to extend Django’s EmailMessage class,\nyou’ll probably want to override this method to put the content you\nwant into the Python EmailMessage object.
Returns a list of all the recipients of the message, whether they’re\nrecorded in the to, cc or bcc attributes. This is another\nmethod you might need to override when subclassing, because the SMTP\nserver needs to be told the full list of recipients when the message\nis sent. If you add another way to specify recipients in your class,\nthey need to be returned from this method as well.
Creates a new attachment and adds it to the message. There are two ways\nto call attach():
You can pass it three arguments: filename, content and\nmimetype. filename is the name of the file attachment as it\nwill appear in the email, content is the data that will be\ncontained inside the attachment and mimetype is the optional MIME\ntype for the attachment. If you omit mimetype, the MIME content\ntype will be guessed from the filename of the attachment.
Na przykład:
\nmessage.attach("design.png", img_data, "image/png")\nIf you specify a mimetype of message/rfc822,\ncontent can be a django.core.mail.EmailMessage or\nPython’s email.message.EmailMessage or\nemail.message.Message.
For a mimetype starting with text/, content is\nexpected to be a string. Binary data will be decoded using UTF-8,\nand if that fails, the MIME type will be changed to\napplication/octet-stream and the data will be attached\nunchanged.
Or for attachments requiring additional headers or parameters, you\ncan pass attach() a single Python\nMIMEPart object. This will be attached\ndirectly to the resulting message. For example, to attach an inline\nimage with a 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")\nPython’s email.contentmanager.set_content() documentation\ndescribes the supported arguments for MIMEPart.set_content().
Creates a new attachment using a file from your filesystem. Call it\nwith the path of the file to attach and, optionally, the MIME type to\nuse for the attachment. If the MIME type is omitted, it will be guessed\nfrom the filename. You can use it like this:
\nmessage.attach_file("/images/weather_map.png")\nFor MIME types starting with text/, binary data is handled\nas in attach().
A named tuple to store attachments to an email.
\nThe named tuple has the following indexes:
\nfilename
content
mimetype
It can be useful to include multiple versions of the content in an email; the\nclassic example is to send both text and HTML versions of a message. With\nDjango’s email library, you can do this using the\nEmailMultiAlternatives class.
A subclass of EmailMessage that allows additional versions of the\nmessage body in the email via the attach_alternative() method. This\ndirectly inherits all methods (including the class initialization) from\nEmailMessage.
A list of EmailAlternative named tuples.\nThis is particularly useful in tests:
self.assertEqual(len(msg.alternatives), 1)\nself.assertEqual(msg.alternatives[0].content, html_content)\nself.assertEqual(msg.alternatives[0].mimetype, "text/html")\nAlternatives should only be added using the attach_alternative()\nmethod, or passed to the constructor.
Attach an alternative representation of the message body in the email.
\nFor example, to send a text and HTML combination, you could write:
\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()\nReturns a boolean indicating whether the provided text is\ncontained in the email body and in all attached MIME type\ntext/* alternatives.
This can be useful when testing emails. For example:
\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)\nA named tuple to store alternative versions of email content.
\nThe named tuple has the following indexes:
\ncontent
mimetype
By default, the MIME type of the body parameter in an EmailMessage\nis "text/plain". It is good practice to leave this alone, because it\nguarantees that any recipient will be able to read the email, regardless of\ntheir mail client. However, if you are confident that your recipients can\nhandle an alternative content type, you can use the content_subtype\nattribute on the EmailMessage class to change the main content type.\nThe major type will always be "text", but you can change the subtype. For\nexample:
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.
Establishing and closing an SMTP connection (or any other network connection,\nfor that matter) is an expensive process. If you have a lot of emails to send,\nit makes sense to reuse an SMTP connection, rather than creating and\ndestroying a connection every time you want to send an email.
\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.\nThe actual sending of an email is handled by the email backend.
\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.)
Przykład:
\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.)
This backend is not intended for use in production – it is provided as a\nconvenience that can be used during development.
\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.)
This backend is not intended for use in production – it is provided as a\nconvenience that can be used during development.
\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.
\nThis backend is not intended for use in production – it is provided as a\nconvenience that can be used during development and testing.
\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.
This backend is not intended for use in production – it is provided as a\nconvenience that can be used during development.
\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.
Custom email backends should subclass BaseEmailBackend that is located in\nthe django.core.mail.backends.base module. A custom email backend must\nimplement the send_messages(email_messages) method. This method receives a\nlist of EmailMessage instances and returns the number of successfully\ndelivered messages. If your backend has any concept of a persistent session or\nconnection, you should also implement the open() and close() methods.\nRefer to smtp.EmailBackend for a reference implementation.
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.
All other keyword arguments are passed directly to the constructor of the\nemail backend.
Instances of an email backend class have the following methods:
\nopen() instantiates a long-lived email-sending connection.
close() closes the current email-sending connection.
send_messages(email_messages) sends a list of EmailMessage\nobjects. If the connection is not open, this call will implicitly open the\nconnection, and close the connection afterward. If the connection is already\nopen, it will be left open after mail has been sent.
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.
There are times when you do not want Django to send emails at\nall. For example, while developing a website, you probably don’t want\nto send out thousands of emails – but you may want to validate that\nemails will be sent to the right people under the right conditions,\nand that those emails will contain the correct content.
\nThe easiest way to configure email for local development is to use the\nconsole email backend. This backend\nredirects all email to stdout, allowing you to inspect the content of mail.
The file email backend can also be useful\nduring development – this backend dumps the contents of every SMTP connection\nto a file that can be inspected at your leisure.
\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.
For information about unit-testing the sending of emails in your application,\nsee the Email services section of the testing documentation.
\n