Enviando e-mailLink para este cabeçalho

Django provides wrappers for Python’s email and smtplib modules to simplify composing and sending email. Django’s email framework also supports swapping in different delivery mechanisms: you can direct email to the console or a file during development and an SMTP server or email service provider in production.

O código pode ser encontrado no módulo django.core.mail.

Quick examplesLink para este cabeçalho

Use send_mail() for straightforward email sending. For example, to send a plain text message:

Code
from django.core.mail import send_mail

send_mail(
    "Subject here",
    "Here is the message.",
    "from@example.com",
    ["to@example.com"],
)

When additional email sending functionality is needed, use the EmailMessage or EmailMultiAlternatives class. For example, to send a multipart email that includes both HTML and plain text versions with a specific template and custom headers, you can use the following approach:

Code
from django.core.mail import EmailMultiAlternatives
from django.template.loader import render_to_string

# First, render the plain text content.
text_content = render_to_string(
    "templates/emails/my_email.txt",
    context={"my_variable": 42},
)

# Secondly, render the HTML content.
html_content = render_to_string(
    "templates/emails/my_email.html",
    context={"my_variable": 42},
)

# Then, create a multipart email instance.
msg = EmailMultiAlternatives(
    subject="Subject here",
    body=text_content,
    from_email="from@example.com",
    to=["to@example.com"],
    headers={"List-Unsubscribe": "<mailto:unsub@example.com>"},
)

# Lastly, attach the HTML content to the email instance and send.
msg.attach_alternative(html_content, "text/html")
msg.send()

Configuring emailLink para este cabeçalho

New Django projects are not configured to send email by default. Instead, email is printed to the console as a development aid (for projects created with startproject) or results in a MailerDoesNotExist error (when the MAILERS setting isn’t defined).

Use the MAILERS setting to tell Django how to send email. For example, to send through an SMTP server running on the local machine:

Code
MAILERS = {
    "default": {
        "BACKEND": "django.core.mail.backends.smtp.EmailBackend",
        "OPTIONS": {
            "host": "localhost",
        },
    },
}

Django abstracts the email sending process into an “email backend” class. Backends de email lists the email backends that come with Django.

The example above uses Django’s SMTP email backend, which sends using the standard SMTP protocol. This backend is useful for many production configurations, including SMTP servers in your own infrastructure and most commercial email service providers (ESPs). There are also third-party email backends available that integrate directly with ESP APIs or add other sending features.

During development or testing you often don’t want to send email at all. Django’s test runner automatically overrides the MAILERS configuration to substitute Django’s memory email backend. This prevents test cases from sending real email and gives them access to the messages that would have been sent. Configurando o email para o desenvolvimento discusses some other approaches.

Multiple mailersLink para este cabeçalho

Sometimes different types of email need to be sent in different ways: e.g., internal vs. external email, different SMTP servers for users in different regions, using different services for transactional notifications and bulk marketing email, etc.

The MAILERS setting can define multiple mail configurations. For example:

Code
import os

MAILERS = {
    "default": {
        "BACKEND": "django.core.mail.backends.smtp.EmailBackend",
        "OPTIONS": {
            "host": "smtp.example.net",
            "use_tls": True,
            "username": os.environ["EMAIL_ACCOUNT_ID"],
            "password": os.environ["EMAIL_API_KEY"],
        },
    },
    "notifications": {
        "BACKEND": "example.third.party.EmailBackend",
        "OPTIONS": {
            "api_key": os.environ["THIRD_PARTY_API_KEY"],
            "region": "eu",
        },
    },
    "admin": {
        "BACKEND": "django.core.mail.backends.smtp.EmailBackend",
        "OPTIONS": {
            "host": "localhost",
        },
    },
}

This defines three mailer configurations:

  • "default" sends through an SMTP server at smtp.example.net with a TLS secured connection. It reads an account id and API key from environment variables and uses them as the SMTP authentication username and password. (Many SMTP services use some variation of this authentication scheme.)

  • "notifications" sends through a hypothetical commercial email service, using a third-party EmailBackend that connects directly to their API. (See Third-party backends for pointers on locating real, community maintained email backend packages.)

  • "admin" sends through an SMTP server running on localhost, with no other options required.

With this configuration, you can provide the using argument to Django’s email sending functions to specify a particular mailer configuration:

Code
from django.core.mail import send_mail

send_mail(
    "Account activated",
    "Congratulations, you're all ready to use our Django app!",
    "from@example.com",
    ["user@example.com"],
    using="notifications",
)

If using is not specified, Django uses the mailer defined for the "default" configuration.

With reusable apps or Django features that send email for you, there may be an option to use a specific mailer configuration. For example, Django’s logging AdminEmailHandler allows specifying the mailer configuration in its using option.

Sending messagesLink para este cabeçalho

django.core.mail provides functions for conveniently sending email, as well as classes for building and sending more complex email messages with attachments and multiple content types.

send_mail()Link para este cabeçalho

send_mail(subject, message, from_email, recipient_list, *, fail_silently=False, auth_user=None, auth_password=None, connection=None, html_message=None)Link para esta definição

django.core.mail.send_mail() sends a single email message.

Os parâmetros subject, message, from_email e recipient_list devem ser informados.

  • subject: uma string.

  • message: uma string.

  • from_email: A string. If None, Django will use the value of the DEFAULT_FROM_EMAIL setting.

  • recipient_list: uma lista de strings, onde cada item representa um endereço de email. Cada membro de recipient_list verá os outros recipientes no campo “To:” da mensagem de email.

The following parameters are optional, and must be given as keyword arguments if used.

  • fail_silently: A boolean, default False. If set True, send_mail() will suppress some errors during sending. (The exact exceptions ignored depend on the email backend in use.)

  • auth_user: O username opcional para ser usado na autenticação do servidor SMTP. Se isso não for fornecido, o Django irá usar o valor da configuração EMAIL_HOST_USER.

  • auth_password: A senha opcional para ser usada na autenticação no servidor SMTP. Se isso não for fornecido, o Django irá usar o valor da configuração EMAIL_HOST_PASSWORD.

  • connection: O backend opcional a ser usado para o de email. Se indefinido, uma instância do backend default será usada. Veja a documentação em Email backends para mais detalhes.

  • html_message: Se html_message for fornecido, o email resultante será um multipart/alternative email com message sendo do tipo text/plain e html_message sendo do tipo text/html.

  • using: An optional MAILERS alias to use to send the mail. If unspecified, the default mailer configuration will be used.

fail_silently, auth_user, auth_password, and connection are not allowed with the using argument.

O valor retornado será o número de mensagens entregues com sucesso (o que pode ser 0 ou 1 já que ele só pode enviar uma mensagem).

send_mass_mail()Link para este cabeçalho

send_mass_mail(datatuple, *, fail_silently=False, auth_user=None, auth_password=None, connection=None, using=None)Link para esta definição

django.core.mail.send_mass_mail() foi pensado para manipular envios massivos de email.

datatuple é uma tupla na qual cada elemento possui o seguinte formato:

Code
(subject, message, from_email, recipient_list)

fail_silently, auth_user, auth_password and connection have the same functions as in send_mail(). They must be given as keyword arguments if used, and are not allowed with the using argument.

The keyword argument using is an optional MAILERS alias to use to send the mail. If unspecified, the default mailer configuration will be used.

Each separate element of datatuple results in a separate email message. As in send_mail(), recipients in the same recipient_list will all see the other addresses in the email messages’ “To:” field.

Por exemplo, o código abaixo enviaria duas mensagens diferentes para dois conjuntos diferentes de destinatários; porém, somente uma conexão para o servidor de email seria aberta:

Code
message1 = (
    "Subject here",
    "Here is the message",
    "from@example.com",
    ["first@example.com", "other@example.com"],
)
message2 = (
    "Another Subject",
    "Here is another message",
    "from@example.com",
    ["second@test.com"],
)
send_mass_mail((message1, message2))

O valor de retorno será o número de mensagens entregues com sucesso.

send_mass_mail() vs. send_mail()Link para este cabeçalho

The main difference between send_mass_mail() and repeatedly calling send_mail() is that send_mail() opens a connection to the mail server each time it’s executed, while send_mass_mail() uses a single connection for all of its messages. This makes send_mass_mail() slightly more efficient.

send_mail() with multiple to addresses sends a single email message, with john@example.com and jane@example.com both appearing in the “To:” field:

Code
send_mail(
    "Subject",
    "Message.",
    "from@example.com",
    ["john@example.com", "jane@example.com"],
)

send_mass_mail() sends a separate message per datatuple element, so john@example.com and jane@example.com each receive their own email:

Code
datatuple = (
    ("Subject", "Message.", "from@example.com", ["john@example.com"]),
    ("Subject", "Message.", "from@example.com", ["jane@example.com"]),
)
send_mass_mail(datatuple)

mail_admins()Link para este cabeçalho

mail_admins(subject, message, *, fail_silently=False, connection=None, html_message=None, using=None)Link para esta definição

django.core.mail.mail_admins() é um atalho para o envio de email para os admins do site, conforme definido na configuração ADMINS setting.

mail_admins() prefixa o conteúdo com o valor da configuração EMAIL_SUBJECT_PREFIX, que é "[Django] " por padrão.

O cabeçalho “From:” do email será o valor da configuração SERVER_EMAIL.

Esse método existe por conveniência e legibilidade.

Se html_message é fornecido, o email resultante será um email do tipo multipart/alternative com message sendo do tipo text/plain e html_message sendo do tipo text/html.

The keyword argument using is an optional MAILERS alias to use to send the mail. If unspecified, the default mailer configuration will be used.

mail_managers()Link para este cabeçalho

mail_managers(subject, message, *, fail_silently=False, connection=None, html_message=None, using=None)Link para esta definição

django.core.mail.mail_managers() é parecido com mail_admins(), exceto pelo fato de que ele envia um email para os mantenedores do site, conforme definido na configuração MANAGERS.

The keyword argument using is an optional MAILERS alias to use to send the mail. If unspecified, the default mailer configuration will be used.

A classe EmailMessageLink para este cabeçalho

Django’s send_mail() and send_mass_mail() functions are actually thin wrappers that make use of the EmailMessage class.

Not all features of the EmailMessage class are available through the send_mail() and related wrapper functions. If you wish to use advanced features, such as BCC’ed recipients, file attachments, or multi-part email, you’ll need to create EmailMessage instances directly.

EmailMessage is responsible for creating the email message itself. The email backend is then responsible for sending the email.

For convenience, EmailMessage provides a send() method for sending a single email. If you need to send multiple messages, the email backend API provides an alternative.

class EmailMessageLink para esta definição

The EmailMessage class is initialized with the following parameters. All parameters are optional and can be set at any time prior to calling the send() method.

The first four parameters can be passed as positional or keyword arguments, but must be in the given order if positional arguments are used:

  • subject: A linha de assunto do email.

  • body: O corpo do texto. Deve ser uma mensagem em texto simples.

  • from_email: The sender’s address. Both fred@example.com and "Fred" <fred@example.com> forms are supported (see Formatting email addresses). If omitted, the DEFAULT_FROM_EMAIL setting is used.

  • to: Uma lista de tuplas de endereços dos destinatários.

The following parameters must be given as keyword arguments if used:

  • cc: uma lista ou tupla de endereços de destinatários usados no cabeçalho “Cc” no envio do email.

  • bcc: A list or tuple of addresses used for blind carbon copies when sending the email.

  • reply_to: uma lista ou tupla de endereços de destinatários usados no cabeçalho “Reply-To” no envio do email.

  • attachments: A list of attachments to put on the message. Each can be an instance of MIMEPart or EmailAttachment, or a tuple with attributes (filename, content, mimetype).

  • headers: um dicionário de cabeçalhos extras para colocar na mensagem. As chaves são os nomes dos cabeçalhos, valores são os valores do cabeçalho. É responsabilidade de quem chama garantir que os nomes e valores dos cabeçalhos estão no formato correto para uma mensagem de email. O atributo correspondente é extra_headers.

  • connection: An email backend instance. This parameter is ignored when using send_messages().

Por exemplo:

Code
from django.core.mail import EmailMessage

email = EmailMessage(
    subject="Hello",
    body="Body goes here",
    from_email="from@example.com",
    to=["to1@example.com", "to2@example.com"],
    bcc=["bcc@example.com"],
    reply_to=["another@example.com"],
    headers={"Message-ID": "foo"},
)

A classe possui os seguintes métodos:

send(fail_silently=False, *, using=None)Link para esta definição

Sends the message. Returns 1 if the message was sent successfully, otherwise 0. (An empty list of recipients returns 0 – it will not raise an exception.)

The optional using keyword argument specifies a MAILERS alias to use to send the mail. If not given, the default mailer configuration will be used.

If a deprecated connection was specified when the email was constructed, that connection will be used. Providing both a connection and using will raise an error.

If the deprecated keyword argument fail_silently is True, certain backend-dependent exceptions while sending the message will be ignored. Providing both fail_silently and using will raise an error.

message(*, policy=email.policy.default)Link para esta definição

Constructs and returns a Python email.message.EmailMessage object representing the message to be sent.

The keyword argument policy allows specifying the set of rules for updating and serializing the representation of the message. It must be an email.policy.Policy object. Defaults to email.policy.default. In certain cases you may want to use SMTP, SMTPUTF8 or a custom policy. For example, the SMTP email backend uses the SMTP policy to ensure \r\n line endings as required by the SMTP protocol.

If you ever need to extend Django’s EmailMessage class, you’ll probably want to override this method to put the content you want into the Python EmailMessage object.

recipients()Link para esta definição

Returns a list of all the recipients of the message, whether they’re recorded in the to, cc or bcc attributes. This is another method you might need to override when subclassing, because the SMTP server needs to be told the full list of recipients when the message is sent. If you add another way to specify recipients in your class, they need to be returned from this method as well.

attach(filename, content, mimetype)Link para esta definição
attach(mimepart)

Creates a new attachment and adds it to the message. There are two ways to call attach():

  • You can pass it three arguments: filename, content and mimetype. filename is the name of the file attachment as it will appear in the email, content is the data that will be contained inside the attachment and mimetype is the optional MIME type for the attachment. If you omit mimetype, the MIME content type will be guessed from the filename of the attachment.

    Por exemplo:

    Code
    message.attach("design.png", img_data, "image/png")
    

    If you specify a mimetype of message/rfc822, content can be a django.core.mail.EmailMessage or Python’s email.message.EmailMessage or email.message.Message.

    For a mimetype starting with text/, content is expected to be a string. Binary data will be decoded using UTF-8, and if that fails, the MIME type will be changed to application/octet-stream and the data will be attached unchanged.

  • Or for attachments requiring additional headers or parameters, you can pass attach() a single Python MIMEPart object. This will be attached directly to the resulting message. For example, to attach an inline image with a Content-ID:

    Code
    import email.utils
    from email.message import MIMEPart
    from django.core.mail import EmailMultiAlternatives
    
    message = EmailMultiAlternatives(...)
    image_data_bytes = ...  # Load image as bytes
    
    # Create a random Content-ID, including angle brackets
    cid = email.utils.make_msgid()
    inline_image = email.message.MIMEPart()
    inline_image.set_content(
        image_data_bytes,
        maintype="image",
        subtype="png",  # or "jpeg", etc. depending on the image type
        disposition="inline",
        cid=cid,
    )
    message.attach(inline_image)
    # Refer to Content-ID in HTML without angle brackets
    message.attach_alternative(f'… <img src="cid:{cid[1:-1]}"> …', "text/html")
    

    Python’s email.contentmanager.set_content() documentation describes the supported arguments for MIMEPart.set_content().

attach_file(path, mimetype=None)Link para esta definição

Creates a new attachment using a file from your filesystem. Call it with the path of the file to attach and, optionally, the MIME type to use for the attachment. If the MIME type is omitted, it will be guessed from the filename. You can use it like this:

Code
message.attach_file("/images/weather_map.png")

For MIME types starting with text/, binary data is handled as in attach().

class EmailAttachmentLink para esta definição

A named tuple to store attachments to an email.

The named tuple has the following indexes:

  • filename

  • content

  • mimetype

Enviando tipos de conteúdo alternativosLink para este cabeçalho

Sending multiple content versionsLink para este cabeçalho

It can be useful to include multiple versions of the content in an email; the classic example is to send both text and HTML versions of a message. With Django’s email library, you can do this using the EmailMultiAlternatives class.

class EmailMultiAlternativesLink para esta definição

A subclass of EmailMessage that allows additional versions of the message body in the email via the attach_alternative() method. This directly inherits all methods (including the class initialization) from EmailMessage.

alternativesLink para esta definição

A list of EmailAlternative named tuples. This is particularly useful in tests:

Code
self.assertEqual(len(msg.alternatives), 1)
self.assertEqual(msg.alternatives[0].content, html_content)
self.assertEqual(msg.alternatives[0].mimetype, "text/html")

Alternatives should only be added using the attach_alternative() method, or passed to the constructor.

attach_alternative(content, mimetype)Link para esta definição

Attach an alternative representation of the message body in the email.

For example, to send a text and HTML combination, you could write:

Code
from django.core.mail import EmailMultiAlternatives

subject = "hello"
from_email = "from@example.com"
to = "to@example.com"
text_content = "This is an important message."
html_content = "<p>This is an <strong>important</strong> message.</p>"
msg = EmailMultiAlternatives(subject, text_content, from_email, [to])
msg.attach_alternative(html_content, "text/html")
msg.send()
body_contains(text)Link para esta definição

Returns a boolean indicating whether the provided text is contained in the email body and in all attached MIME type text/* alternatives.

This can be useful when testing emails. For example:

Code
def test_contains_email_content(self):
    subject = "Hello World"
    from_email = "from@example.com"
    to = "to@example.com"
    msg = EmailMultiAlternatives(subject, "I am content.", from_email, [to])
    msg.attach_alternative("<p>I am content.</p>", "text/html")

    self.assertIs(msg.body_contains("I am content"), True)
    self.assertIs(msg.body_contains("<p>I am content.</p>"), False)
class EmailAlternativeLink para esta definição

A named tuple to store alternative versions of email content.

The named tuple has the following indexes:

  • content

  • mimetype

Updating the default content typeLink para este cabeçalho

By default, the MIME type of the body parameter in an EmailMessage is "text/plain". It is good practice to leave this alone, because it guarantees that any recipient will be able to read the email, regardless of their mail client. However, if you are confident that your recipients can handle an alternative content type, you can use the content_subtype attribute on the EmailMessage class to change the main content type. The major type will always be "text", but you can change the subtype. For example:

Code
msg = EmailMessage(subject, html_content, from_email, [to])
msg.content_subtype = "html"  # Main content is now text/html
msg.send()

Safely sending emailLink para este cabeçalho

Any public website that can send email will eventually be targeted by attempts to abuse it for spam, phishing, or other malicious content. While a complete discussion of vulnerabilities in sending email is beyond the scope of Django’s documentation, there are many references available on the web. Two good starting points are:

Thinking through how email might be abused (and taking steps to mitigate it) is especially important if your site can send to unverified addresses. Features like newsletter sign-up, contact forms that cc or auto-reply to the sender, and “share this page” can be attractive targets.

Formatting email addressesLink para este cabeçalho

Email addresses allow a “friendly” display name alongside the user@domain address. For example, you could include your company name in the DEFAULT_FROM_EMAIL setting:

Code
DEFAULT_FROM_EMAIL = '"Example, Inc." <contact@example.com>'

The double quotes around "Example, Inc." are needed so the comma isn’t read as separating two different addresses. A fixed address, written out by hand as in the example above, is safe, but composing one from variable parts (especially untrusted input) needs more care.

Email address headers have complex syntax rules (much like HTML or SQL), so constructing them by combining strings creates an injection vulnerability. Even if you’ve validated the format of email, an attacker could exploit the name portion to inject additional addresses.

To avoid this, always use a well-tested library specifically meant to format email addresses, like Python’s email.headerregistry.Address class (the replacement for the legacy formataddr() function, which does not support internationalized domain names).

For example, to include a user’s full name when sending them email (where user is an instance of the default User model):

Code
from django.core.mail import send_mail
from email.headerregistry import Address


def send_mail_to_user(user, subject, body, from_email=None):
    # Safely create an email address with the user's name.
    # (addr_spec is the technical term for the user@domain address.)
    address = Address(
        display_name=user.get_full_name(),
        addr_spec=user.email,
    )
    send_mail(subject, body, from_email, [address])

Django’s built-in email backends support using Address objects directly in any address field, as shown here. So do many custom and third-party email backends. But if this causes a TypeError or other problem with a particular backend, use str(address) to convert the object to a safe, properly formatted string.

Prevenindo injeção de cabeçalhosLink para este cabeçalho

Email header injection is a security exploit in which an attacker manipulates email headers to change the intended sender or recipients, subject, or potentially even the entire visible message body.

One type of header injection exploits address header syntax. You are responsible for preventing this when constructing email addresses from user-supplied input, as described in Formatting email addresses above.

Another (perhaps better understood) attack, CRLF injection, uses carriage return and line feed characters to insert additional headers into the email. Django prevents this by raising a ValueError if those characters appear in any header field when trying to send the message.

Django’s CRLF protection relies on using Python’s modern EmailPolicy in Django’s EmailMessage.message(). Custom email backends that don’t call that function, or that call it with the legacy compat32 policy, are responsible for implementing their own CRLF injection prevention.

Sending many messages efficientlyLink para este cabeçalho

Estabelecer e fechar uma conexão SMTP (ou qualquer outra conexão de rede, nesse caso) é um processo custoso. Se você tem muitos emails para enviar, faz sentido reutilizar uma conexão SMTP, ao invés de criar e destruir uma conexão toda vez que você desejar enviar um email.

There are two ways to tell an email backend to reuse a connection. Both involve obtaining an email backend instance from mail.mailers and using the backend’s API.

The first approach is to use the backend’s send_messages() method. This takes a list of EmailMessage (or subclass) instances, and sends them all using that single connection.

For example, if you have a function called get_notification_emails() that returns a list of EmailMessage objects representing some periodic email you wish to send out, you could send these emails using a single call to send_messages():

Code
from django.core import mail

email_list = get_notification_emails()
# Use the default mailer. You could substitute
# mail.mailers["alias"] for a specific mailer.
backend = mail.mailers.default
backend.send_messages(email_list)

In this example, the call to send_messages() opens a connection on the backend, sends the list of messages, and then closes the connection again. (This is how send_mass_mail() is implemented.)

The second approach is to use the open() and close() methods on the email backend to manually control the connection. send_messages() will not open or close the connection if it is already open, so if you manually open the connection, you can control when it is closed. For example:

Code
from django.core import mail

# Use the "notifications" mailer configuration.
backend = mail.mailers["notifications"]

# Manually open the connection.
backend.open()

# Construct an email message. (Passing None as the third argument
# uses settings.DEFAULT_FROM_EMAIL as the "From:" address.)
email1 = mail.EmailMessage("Hi", "Message", None, ["to1@example.com"])
# Send the email. The connection was already open, so send_messages()
# leaves it open after sending.
backend.send_messages([email1])

# Construct and send two more messages. The connection is still open.
email2 = mail.EmailMessage("Hi", "Message", None, ["to2@example.com"])
email3 = mail.EmailMessage("Hi", "Message", None, ["to3@example.com"])
backend.send_messages([email2, email3])

# Because we opened it, we need to manually close the connection.
backend.close()

When you manually open a backend’s connection, you are responsible for ensuring it gets closed. The example above actually has a bug: if an exception occurs while sending the messages, the connection will not be closed. This can be fixed with a try-finally statement, but using the backend instance as a context manager is preferable, as it automatically calls open() and close() as needed.

This is equivalent to the previous example, but uses the backend as a context manager to avoid leaving the connection open on errors:

Code
from django.core import mail

# Use mail.mailers[...] as a context manager.
with mail.mailers["notifications"] as backend:
    # The backend connection is automatically opened inside the context.
    email1 = mail.EmailMessage("Hi", "Message", None, ["to1@example.com"])
    backend.send_messages([email1])

    # The connection is still open, and is reused for the second send.
    email2 = mail.EmailMessage("Hi", "Message", None, ["to2@example.com"])
    email3 = mail.EmailMessage("Hi", "Message", None, ["to3@example.com"])
    backend.send_messages([email2, email3])

# After exiting the context (either normally or because of an error),
# the backend connection is automatically closed.

Backends de emailLink para este cabeçalho

O envio de email em si é manipulado pelo email backend.

Django comes with several email backends. With the exception of the SMTP backend, these are mainly useful during testing and development. If the built-in backends don’t meet your needs there are third-party packages available. You can also subclass one of the built-in backends to change its behavior, or even write your own email backend.

SMTP backendLink para este cabeçalho

The SMTP email backend connects to an SMTP server to send email. To use it, set BACKEND to "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, uses the standard port for the connection protocol depending on the "use_tls" and "use_ssl" options: 587 for TLS, 465 for SSL, or 25 for an unsecured connection.

  • "username" and "password": set these if your server requires SMTP authentication (“SMTP AUTH” credentials, sometimes called SMTP login).

    Although the username is often an email address, it should not be confused with default “From:” addresses. Those are defined by the DEFAULT_FROM_EMAIL and SERVER_EMAIL settings.

  • "use_tls" or "use_ssl": set one of these options to True to connect to the SMTP server using a secure protocol – "use_tls" for explicit TLS or "use_ssl" for SSL (implicit TLS).

  • "ssl_certfile" and "ssl_keyfile": if the SMTP server’s SSL/TLS connection requires client certificate authentication, use these options to specify the paths to a PEM-formatted certificate chain file and private key file. (The key file can be omitted if the certificate file includes the private key.)

    These options are not intended for use with a private certificate authority or self-signed SMTP server certificate. See Private and self-signed SMTP server certificates below.

    Note that these options don’t result in checking certificate validity. They are passed to the underlying SSL connection. Refer to the documentation of Python’s ssl.SSLContext.wrap_socket() method for details on how the certificate chain file and private key file are handled.

  • "timeout": the timeout (in seconds) for connecting to the SMTP server and other blocking operations. If not specified, the value is obtained from socket.getdefaulttimeout(), which defaults to no timeout (None) meaning SMTP operations can block indefinitely.

  • "fail_silently": set to True to ignore certain errors while sending a message. All OSErrors are ignored while opening the SMTP connection, and smtplib.SMTPException errors are ignored while communicating with the server. This will suppress both transient network glitches and also serious configuration problems. However, it does not ignore all errors, and problems with serializing the message will not fail silently. (This option is available for backward compatibility but is not recommended for typical use.)

Exemplo

Code
MAILERS = {
    "default": {
        "BACKEND": "django.core.mail.backends.smtp.EmailBackend",
        "OPTIONS": {
            "host": "smtp.example.net",
            "use_tls": True,
            "username": "my-app",
            "password": os.environ["MY_APP_SMTP_PASSWORD"],
            "timeout": 10,
        },
    },
}
class backends.smtp.EmailBackendLink para esta definição

Directly instantiating an EmailBackend class is not recommended. Use mailers to obtain a backend instance.

When constructed directly (without going through mailers), the SMTP EmailBackend class accepts the options listed above as keyword arguments. Default values come from the corresponding, deprecated EMAIL_* settings. host is not required and defaults to "localhost", and port defaults to 25 even if use_tls or use_ssl is True.

When the MAILERS setting is defined, attempting to directly create an SMTP EmailBackend will raise an AttributeError.

Private and self-signed SMTP server certificatesLink para este cabeçalho

If the SMTP server uses an SSL certificate from a private certificate authority (CA), the CA’s root certificate should be added to the system CA bundle on the client (where Django is running). Likewise, if the server uses a self-signed certificate, it should be added to the client’s system CA bundle so it can be trusted. (The SMTP backend’s "ssl_certfile" option cannot be used for CA roots or self-signed certificates.)

Follow platform-specific instructions for adding to the system CA bundle. If modifying the system bundle is not possible or desired, an alternative is using OpenSSL’s SSL_CERT_FILE or SSL_CERT_DIR environment variables to specify a custom certificate bundle.

For more complex scenarios, the SMTP backend can be subclassed to add root certificates to its ssl_context using ssl.SSLContext.load_verify_locations().

Console backendLink para este cabeçalho

Instead of sending out real emails, the console backend writes the emails that would 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 message to the stream, including errors serializing the message. (This option is available for backward compatibility but is not recommended.)

Esse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.

File backendLink para este cabeçalho

The file backend writes emails to a file. A new file is created for each new session 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 be a string or a pathlib.Path object. If the directory does not exist, the file backend will attempt to create it.

  • "fail_silently": set to True to ignore all errors while writing the message to the file – including errors serializing the message – but not errors related to ensuring the file path directory exists. (This option is available for backward compatibility but is not recommended.)

Esse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.

In-memory backendLink para este cabeçalho

The 'locmem' backend stores messages in a special attribute of the django.core.mail module. The outbox attribute is created when the first message is sent. It’s a list with an EmailMessage instance for each message that would be sent. Messages in the outbox are annotated with a sent_using attribute that identifies the MAILERS alias used to send the message.

To use the in-memory backend, set BACKEND to "django.core.mail.backends.locmem.EmailBackend". It does not support any OPTIONS.

Django’s test runner automatically switches to this backend for testing.

Esse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento e teste.

Dummy backendLink para este cabeçalho

As the name suggests the dummy backend does nothing with your messages. To use it, set BACKEND to "django.core.mail.backends.dummy.EmailBackend". It does not support any OPTIONS.

Esse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.

Third-party backendsLink para este cabeçalho

Third-party email backends are available that:

  • Integrate directly with commercial email service providers’ APIs (which often have 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 logging sent messages.

  • Provide development and debugging tools, such as sandbox capture and in-browser email previews.

Definindo um email backend customizadoLink para este cabeçalho

If you need to change how emails are sent you can write your own email backend. To use a custom backend, set BACKEND to the Python import path for your backend class and OPTIONS to any __init__() keyword arguments your backend supports.

Custom email backends should subclass BaseEmailBackend that is located in the django.core.mail.backends.base module. A custom email backend must implement the send_messages(email_messages) method. This method receives a list of EmailMessage instances and returns the number of successfully delivered messages. If your backend has any concept of a persistent session or connection, you should also implement the open() and close() methods. Refer to smtp.EmailBackend for a reference implementation.

Obtendo uma instância de um email backendLink para este cabeçalho

The mailers factory in django.core.mail returns instances of email backends.

mailersLink para esta definição

You can access the mailers configured in the MAILERS setting through a dict-like object: django.core.mail.mailers:

Python console
>>> from django.core.mail import mailers
>>> mailers["notifications"]

If the named key is not defined, a MailerDoesNotExist error will be raised. Other configuration problems will raise an InvalidMailer error.

mailers.defaultLink para esta definição

As a shortcut, the default mailer can be accessed through django.core.mail.mailers.default:

Python console
>>> from django.core.mail import mailers
>>> mailers.default

This is equivalent to mailers["default"]. If no default mailer has been configured, a MailerDoesNotExist error will be raised.

get_connection(backend=None, *, fail_silently=False, **kwargs)Link para esta definição

The deprecated django.core.mail.get_connection() function creates and returns an instance of an email backend. Its behavior depends on the MAILERS setting and how the function is called.

If the MAILERS setting is defined:

  • get_connection() with no arguments will return mailers.default.

  • get_connection(...) called with only fail_silently or other keyword arguments will create an instance of MAILERS["default"] with any keywords added to the default mailer’s OPTIONS.

  • get_connection(backend, ...) with a backend import path will raise an error.

If the MAILERS setting is not defined:

  • get_connection() with no arguments will return an instance of the email backend specified in EMAIL_BACKEND.

  • If you specify the backend argument, an instance of that backend will be instantiated.

  • If the keyword argument fail_silently is True, certain backend-dependent exceptions during the email sending process will be silently ignored.

  • All other keyword arguments are passed directly to the constructor of the email backend.

Email backend APILink para este cabeçalho

Instances of an email backend class have the following methods:

  • open() instancia uma conexão de longa duração para envio de email.

  • close() fecha a conexão atual de envio de email.

  • send_messages(email_messages) sends a list of EmailMessage objects. If the connection is not open, this call will implicitly open the connection, and close the connection afterward. If the connection is already open, it will be left open after mail has been sent.

A backend instance can also be used as a context manager, which will automatically call open() and close() as needed. An example is in Sending many messages efficiently.

Configurando o email para o desenvolvimentoLink para este cabeçalho

Existem momentos em que você não quer que o Django envie quaisquer emails. Por exemplo, enquanto estiver desenvolvendo um website, você provavelmente não quer enviar milhares de emails – mas você pode querer validar que esses email serão enviados para as pessoas certas nas condições certas, e que esses emails irão conter o conteúdo correto.

The easiest way to configure email for local development is to use the console email backend. This backend redirects all email to stdout, allowing you to inspect the content of mail.

O file email backend também pode ser útil durante o desenvolvimento – esse backend despeja o conteúdo de todoas as conexões SMTP para um arquivo que pode ser inspecionado quando você desejar.

Another approach is to use a mocked SMTP server that receives the emails locally and displays them to the terminal, but does not actually send anything. The aiosmtpd package provides a way to accomplish this:

Shell
python -m pip install "aiosmtpd >= 1.4.5"

python -m aiosmtpd -n -l localhost:8025

This command will start a minimal SMTP server listening on port 8025 of localhost. This server prints to standard output all email headers and the email body. You then only need to set an SMTP backend’s "host" and "port" OPTIONS accordingly. For a more detailed discussion of SMTP server options, see the documentation of the aiosmtpd module.

Para mais informações sobre testes unitários no envio de emails em suas aplicações, veja a seção Serviços de E-mail sobre testes da documentação.