Although Python provides a mail sending interface via the smtplib\nmodule, Django provides a couple of light wrappers over it. These wrappers are\nprovided to make sending email extra quick, to help test email sending during\ndevelopment, 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\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 fail_silently=False,\n)\nWhen additional email sending functionality is needed, use\nEmailMessage or EmailMultiAlternatives. For example, to send\na multipart email that includes both HTML and plain text versions with a\nspecific template and custom headers, you can use the following 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()\nO 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.
send_mail()Link para este cabeçalho#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\nDEFAULT_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\nif used.
\nfail_silently: A boolean. When it’s False, send_mail() will raise\nan smtplib.SMTPException if an error occurs. See the smtplib\ndocs for a list of possible exceptions, all of which are subclasses of\nSMTPException.
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).
send_mass_mail()Link para este cabeçalho#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)\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.
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.
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:
\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), fail_silently=False)\nO valor de retorno será o número de mensagens entregues com sucesso.
\n\nsend_mass_mail() vs. send_mail()Link para este cabeçalho#The main difference between send_mass_mail() and send_mail() is\nthat send_mail() opens a connection to the mail server each time it’s\nexecuted, while send_mass_mail() uses a single connection for all of its\nmessages. This makes send_mass_mail() slightly more efficient.
mail_admins()Link para este cabeçalho#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.
\nSe 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.
mail_managers()Link para este cabeçalho#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.
Isso envia um único email para john@example.com e jane@example.com, com ambos aparecendo no campo “To:”:
\nsend_mail(\n "Subject",\n "Message.",\n "from@example.com",\n ["john@example.com", "jane@example.com"],\n)\nThis sends a message to john@example.com and jane@example.com, with\nthem both receiving a separate 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)\ninjeçã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.
\nThe Django email functions outlined above all protect against header injection\nby forbidding newlines in header values. If any subject, from_email or\nrecipient_list contains a newline (in either Unix, Windows or Mac style),\nthe email function (e.g. send_mail()) will raise ValueError and,\nhence, will not send the email. It’s your responsibility to validate all data\nbefore passing it to the email functions.
If a message contains headers at the start of the string, the headers will\nbe printed as the first bit of the email message.
Here’s an example view that takes a subject, message and from_email\nfrom the request’s POST data, sends that to admin@example.com and redirects\nto “/contact/thanks/” when it’s done:
from django.core.mail import send_mail\nfrom django.http import HttpResponse, HttpResponseRedirect\n\n\ndef send_email(request):\n subject = request.POST.get("subject", "")\n message = request.POST.get("message", "")\n from_email = request.POST.get("from_email", "")\n if subject and message and from_email:\n try:\n send_mail(subject, message, from_email, ["admin@example.com"])\n except ValueError:\n return HttpResponse("Invalid header found.")\n return HttpResponseRedirect("/contact/thanks/")\n else:\n # In reality we'd use a form class\n # to get proper validation errors.\n return HttpResponse("Make sure all fields are entered and valid.")\nEmailMessageLink para este cabeçalho#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.
EmailMessageLink para este cabeçalho#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: 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\n"Fred" <fred@example.com> forms are legal. If omitted, the\nDEFAULT_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:
\ncc: 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\nbe an instance of MIMEPart or\nEmailAttachment, or a tuple with attributes\n(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.\nUse this parameter if you are sending the EmailMessage via\nsend() and you want to use the same connection for multiple\nmessages. If omitted, a new connection is created when send() is\ncalled. This parameter is ignored when using\nsend_messages().
Por exemplo:
\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)\nA classe possui os seguintes métodos:
\nSends the message. If a connection was specified when the email was\nconstructed, that connection will be used. Otherwise, an instance of\nthe default backend will be instantiated and used. If the keyword\nargument fail_silently is True, exceptions raised while sending\nthe message will be quashed. An empty list of recipients will not raise\nan exception. It will return 1 if the message was sent\nsuccessfully, otherwise 0.
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,\ndjango.core.mail.backends.smtp.EmailBackend uses the\nSMTP policy to ensure \\r\\n line endings as\nrequired 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.
Por exemplo:
\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()\nO envio de email em si é manipulado pelo email backend.
\nA classe do email backend tem os métodos a seguir:
\nopen() 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\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.
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\n\nwith mail.get_connection() as connection:\n mail.EmailMessage(\n subject1,\n body1,\n from1,\n [to1],\n connection=connection,\n ).send()\n mail.EmailMessage(\n subject2,\n body2,\n from2,\n [to2],\n connection=connection,\n ).send()\nThe get_connection() function in django.core.mail returns an\ninstance 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\nhandle errors. If fail_silently is True, exceptions during the email\nsending process will be silently ignored.
All other keyword arguments are passed directly to the constructor of the\nemail backend.
\nO 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.
\n\nEste é o backend padrão. Email será enviado através de um servidor SMTP.
\nO 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:
\nEMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"\nIf unspecified, the default timeout will be the one provided by\nsocket.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:
\nEMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"\nEsse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.
\nThe file backend writes emails to a file. A new file is created for each new\nsession that is opened on this backend. The directory to which the files are\nwritten is either taken from the EMAIL_FILE_PATH setting or from the\nfile_path keyword when creating a connection with get_connection().
Para especificar esse backend, coloque o seguinte nas suas configurações:
\nEMAIL_BACKEND = "django.core.mail.backends.filebased.EmailBackend"\nEMAIL_FILE_PATH = "/tmp/app-messages" # change this to a proper location\nEsse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.
\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.
Para especificar esse backend, coloque o seguinte nas suas configurações:
\nEMAIL_BACKEND = "django.core.mail.backends.locmem.EmailBackend"\nEsse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento e teste.
\nDjango’s test runner automatically uses this backend for testing.
\nComo o nome sugere o dummy backend não faz nada com suas mensagens. Para definir esse backend, coloque o seguinte em suas configurações:
\nEMAIL_BACKEND = "django.core.mail.backends.dummy.EmailBackend"\nEsse backend não é intencionado para uso em produção – ele é fornecido como uma conveniência que pode ser usado durante o desenvolvimento.
\n\nSe 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\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.
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.
\nExistem duas maneiras de dizer a um email backend para reutilizar uma conexão.
\nFirstly, you can use the send_messages() method on a connection. This takes\na list of EmailMessage (or subclass) instances, and sends them all\nusing 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\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\nconnection = mail.get_connection() # Use default email connection\nmessages = get_notification_email()\nconnection.send_messages(messages)\nNeste 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\n\nconnection = mail.get_connection()\n\n# Manually open the connection\nconnection.open()\n\n# Construct an email message that uses the connection\nemail1 = mail.EmailMessage(\n "Hello",\n "Body goes here",\n "from@example.com",\n ["to1@example.com"],\n connection=connection,\n)\nemail1.send() # Send the email\n\n# Construct two more messages\nemail2 = mail.EmailMessage(\n "Hello",\n "Body goes here",\n "from@example.com",\n ["to2@example.com"],\n)\nemail3 = mail.EmailMessage(\n "Hello",\n "Body goes here",\n "from@example.com",\n ["to3@example.com"],\n)\n\n# Send the two emails in a single call -\nconnection.send_messages([email2, email3])\n# The connection was already open so send_messages() doesn't close it.\n# We need to manually close the connection.\nconnection.close()\nExistem 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.
\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.
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.
\nAnother approach is to use a “dumb” 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 the EMAIL_HOST and\nEMAIL_PORT accordingly. For a more detailed discussion of SMTP\nserver 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.
\n