Although Python provides a mail sending interface via the smtplib
module, Django provides a couple of light wrappers over it. These wrappers are
provided to make sending email extra quick, to help test email sending during
development, and to provide support for platforms that can’t use SMTP.
O código pode ser encontrado no módulo django.core.mail.
Use send_mail() for straightforward email sending. For example, to send a
plain text message:
from django.core.mail import send_mail
send_mail(
"Subject here",
"Here is the message.",
"from@example.com",
["to@example.com"],
fail_silently=False,
)
When additional email sending functionality is needed, use
EmailMessage or EmailMultiAlternatives. 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:
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()
O email é enviado usando o host e porta SMTP especificados em EMAIL_HOST e EMAIL_PORT. As configurações EMAIL_HOST_USER e EMAIL_HOST_PASSWORD, se definidas, são usadas para autenticar no servidor SMTP, e as configurações EMAIL_USE_TLS e EMAIL_USE_SSL controlam se uma conexão segura deve ou não ser usada.
Nota
O conjunto de caracteres do email enviado com django.core.mail será definido como sendo o valor da configuração DEFAULT_CHARSET.
send_mail()¶In most cases, you can send email using django.core.mail.send_mail().
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. When it’s False, send_mail() will raise
an smtplib.SMTPException if an error occurs. See the smtplib
docs for a list of possible exceptions, all of which are subclasses of
SMTPException.
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.
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).
Deprecated since version 6.0: Passing fail_silently and later parameters as positional arguments is
deprecated.
send_mass_mail()¶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:
(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.
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:
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), fail_silently=False)
O valor de retorno será o número de mensagens entregues com sucesso.
Deprecated since version 6.0: Passing fail_silently and later parameters as positional arguments is
deprecated.
send_mass_mail() vs. send_mail()¶The main difference between send_mass_mail() and 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.
mail_admins()¶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.
Deprecated since version 6.0: Passing fail_silently and later parameters as positional arguments is
deprecated.
mail_managers()¶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.
Deprecated since version 6.0: Passing fail_silently and later parameters as positional arguments is
deprecated.
Isso envia um único email para john@example.com e jane@example.com, com ambos aparecendo no campo “To:”:
send_mail(
"Subject",
"Message.",
"from@example.com",
["john@example.com", "jane@example.com"],
)
This sends a message to john@example.com and jane@example.com, with
them both receiving a separate email:
datatuple = (
("Subject", "Message.", "from@example.com", ["john@example.com"]),
("Subject", "Message.", "from@example.com", ["jane@example.com"]),
)
send_mass_mail(datatuple)
injeção de cabeçalhos é uma vulnerabilidade de segurança onde um atacante insere cabeçalhos extras no email para controlar os campos “To:” e “From:” em mensagens de email geradas pelos seus scripts.
The Django email functions outlined above all protect against header injection
by forbidding newlines in header values. If any subject, from_email or
recipient_list contains a newline (in either Unix, Windows or Mac style),
the email function (e.g. send_mail()) will raise ValueError and,
hence, will not send the email. It’s your responsibility to validate all data
before passing it to the email functions.
If a message contains headers at the start of the string, the headers will
be printed as the first bit of the email message.
Here’s an example view that takes a subject, message and from_email
from the request’s POST data, sends that to admin@example.com and redirects
to “/contact/thanks/” when it’s done:
from django.core.mail import send_mail
from django.http import HttpResponse, HttpResponseRedirect
def send_email(request):
subject = request.POST.get("subject", "")
message = request.POST.get("message", "")
from_email = request.POST.get("from_email", "")
if subject and message and from_email:
try:
send_mail(subject, message, from_email, ["admin@example.com"])
except ValueError:
return HttpResponse("Invalid header found.")
return HttpResponseRedirect("/contact/thanks/")
else:
# In reality we'd use a form class
# to get proper validation errors.
return HttpResponse("Make sure all fields are entered and valid.")
Older versions raised django.core.mail.BadHeaderError for some
invalid headers. This has been replaced with ValueError.
EmailMessage¶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.
Nota
This is a design feature. send_mail() and related functions were
originally the only interface Django provided. However, the list of
parameters they accepted was slowly growing over time. It made sense to
move to a more object-oriented design for email messages and retain the
original functions only for backwards compatibility.
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.
EmailMessage¶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 legal. 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: uma lista de tuplas de endereços usados no cabeçalho “Bcc” ao enviar o 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).
Support for EmailAttachment items of attachments was
added.
Support for MIMEPart objects in the
attachments list was added.
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.
Use this parameter if you are sending the EmailMessage via
send() and you want to use the same connection for multiple
messages. If omitted, a new connection is created when send() is
called. This parameter is ignored when using
send_messages().
Deprecated since version 6.0: Passing all except the first four parameters as positional arguments is deprecated.
Por exemplo:
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:
Sends the message. If a connection was specified when the email was
constructed, that connection will be used. Otherwise, an instance of
the default backend will be instantiated and used. If the keyword
argument fail_silently is True, exceptions raised while sending
the message will be quashed. An empty list of recipients will not raise
an exception. It will return 1 if the message was sent
successfully, otherwise 0.
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,
django.core.mail.backends.smtp.EmailBackend 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.
The policy keyword argument was added and the return type was
updated to an instance of EmailMessage.
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.
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:
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:
cid = email.utils.make_msgid()
inline_image = email.message.MIMEPart()
inline_image.set_content(
image_data_bytes,
maintype="image",
subtype="png",
disposition="inline",
cid=f"<{cid}>",
)
message.attach(inline_image)
message.attach_alternative(f'… <img src="cid:${cid}"> …', "text/html")
Python’s email.contentmanager.set_content() documentation
describes the supported arguments for MIMEPart.set_content().
Support for MIMEPart attachments was
added.
Deprecated since version 6.0: Support for email.mime.base.MIMEBase attachments is
deprecated. Use MIMEPart instead.
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:
message.attach_file("/images/weather_map.png")
For MIME types starting with text/, binary data is handled
as in attach().
A named tuple to store attachments to an email.
The named tuple has the following indexes:
filename
content
mimetype
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.
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.
A list of EmailAlternative named tuples.
This is particularly useful in tests:
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.
In older versions, alternatives was a list of regular tuples,
as opposed to EmailAlternative named tuples.
Attach an alternative representation of the message body in the email.
For example, to send a text and HTML combination, you could write:
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()
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:
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)
A named tuple to store alternative versions of email content.
The named tuple has the following indexes:
content
mimetype
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:
msg = EmailMessage(subject, html_content, from_email, [to])
msg.content_subtype = "html" # Main content is now text/html
msg.send()
O envio de email em si é manipulado pelo email backend.
A classe do email backend tem os métodos a seguir:
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.
Ela também pode ser usada como em um gerenciador de contexto, que irá automaticamente chamar open() e close() conforme necessário:
from django.core import mail
with mail.get_connection() as connection:
mail.EmailMessage(
subject1,
body1,
from1,
[to1],
connection=connection,
).send()
mail.EmailMessage(
subject2,
body2,
from2,
[to2],
connection=connection,
).send()
The get_connection() function in django.core.mail returns an
instance of the email backend that you can use.
Por padrão, uma chamada para get_connection() irá retornar uma instância do email backend definido em EMAIL_BACKEND. Se você especificar o argumento backend, uma instância desse backend será criada.
The keyword-only fail_silently argument controls how the backend should
handle errors. If fail_silently is True, exceptions during the email
sending process will be silently ignored.
All other keyword arguments are passed directly to the constructor of the email backend.
O Django é fornecido com vários backends de envio de email. Com exceção do backend SMTP (que é o padrão), esses backends só são úteis durante testes e desenvolvimento. Se você tiver requisitos especiais de envio de email, você pode escrever o seu próprio email backend.
Deprecated since version 6.0: Passing fail_silently as positional argument is deprecated.
Este é o backend padrão. Email será enviado através de um servidor SMTP.
O valor de cada argumento é obtido da respectiva configuração se o argumento for None:
host: EMAIL_HOST
port: EMAIL_PORT
username: EMAIL_HOST_USER
password: EMAIL_HOST_PASSWORD
use_tls: EMAIL_USE_TLS
use_ssl: EMAIL_USE_SSL
timeout: EMAIL_TIMEOUT
ssl_keyfile: EMAIL_SSL_KEYFILE
ssl_certfile: EMAIL_SSL_CERTFILE
O backend SMTP é a configuração padrão herdada do Django. Se você quiser especificá-la explicitamente, adicione o seguinte as suas configurações:
EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
If unspecified, the default timeout will be the one provided by
socket.getdefaulttimeout(), which defaults to None (no timeout).
Ao invés de enviar emails reais o console backend escreve esses emails que poderiam ser enviados na saída padrão. Por padrão, o console backend direciona para stdout. Você pode usar diferentes objetos fornecendo o argumento nomeado stream ao construir a conexão.
Para especificar esse backend, coloque o seguinte nas suas configurações:
EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
Esse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.
The file backend writes emails to a file. A new file is created for each new
session that is opened on this backend. The directory to which the files are
written is either taken from the EMAIL_FILE_PATH setting or from the
file_path keyword when creating a connection with get_connection().
Para especificar esse backend, coloque o seguinte nas suas configurações:
EMAIL_BACKEND = "django.core.mail.backends.filebased.EmailBackend"
EMAIL_FILE_PATH = "/tmp/app-messages" # change this to a proper location
Esse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.
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.
Para especificar esse backend, coloque o seguinte nas suas configurações:
EMAIL_BACKEND = "django.core.mail.backends.locmem.EmailBackend"
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.
Django’s test runner automatically uses this backend for testing.
Como o nome sugere o dummy backend não faz nada com suas mensagens. Para definir esse backend, coloque o seguinte em suas configurações:
EMAIL_BACKEND = "django.core.mail.backends.dummy.EmailBackend"
Esse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.
There are community-maintained solutions too!
Django has a vibrant ecosystem. There are email backends highlighted on the Community Ecosystem page. The Django Packages Email grid has even more options for you!
Se você precisa mudar como os emails são enviados você pode escrever o seu próprio email backend. A configuração EMAIL_BACKEND em seu arquivo de configurações é então o caminho Python do import para a sua classe backend.
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.
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.
Existem duas maneiras de dizer a um email backend para reutilizar uma conexão.
Firstly, you can use the send_messages() method on a connection. This takes
a list of EmailMessage (or subclass) instances, and sends them all
using that single connection. As a consequence, any connection set on an individual message is ignored.
For example, if you have a function called get_notification_email() 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():
from django.core import mail
connection = mail.get_connection() # Use default email connection
messages = get_notification_email()
connection.send_messages(messages)
Neste exemplo, a chamada send_messages() abre uma conexão no backend, envia a lista de mensagens, e então fecha a conexão novamente.
A segunda abordagem é usar os métodos open() e close() no backend de email para manualmente controlar a conexão. send_messages() não irá abrir ou fechar manualmente a conexão se ela já estiver aberta, se você manualmente abrir a conexão, você pode controlar quando ela será fechada. Por exemplo:
from django.core import mail
connection = mail.get_connection()
# Manually open the connection
connection.open()
# Construct an email message that uses the connection
email1 = mail.EmailMessage(
"Hello",
"Body goes here",
"from@example.com",
["to1@example.com"],
connection=connection,
)
email1.send() # Send the email
# Construct two more messages
email2 = mail.EmailMessage(
"Hello",
"Body goes here",
"from@example.com",
["to2@example.com"],
)
email3 = mail.EmailMessage(
"Hello",
"Body goes here",
"from@example.com",
["to3@example.com"],
)
# Send the two emails in a single call -
connection.send_messages([email2, email3])
# The connection was already open so send_messages() doesn't close it.
# We need to manually close the connection.
connection.close()
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 “dumb” 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:
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 the EMAIL_HOST and
EMAIL_PORT 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.
dez. 03, 2025