Skicka e-postLink to this heading#

send_mass_mail() vs. send_mail()Link to this heading#

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.

objekten EmailMessageLink to this heading#

class EmailMessageLink to this definition#

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: Ämnesraden för e-postmeddelandet.

• kropp: Texten i brödtexten. Detta bör vara ett vanligt textmeddelande.

• from_email: Avsändarens adress. Både fred@example.com och "Fred" <fred@example.com> är lagliga former. Om den utelämnas används inställningen DEFAULT_FROM_EMAIL.

• till: En lista eller tupel av mottagaradresser.

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

• cc: En lista eller tupel av mottagaradresser som används i ”Cc”-rubriken när e-postmeddelandet skickas.

• bcc: En lista eller tupel av adresser som används i ”Bcc”-rubriken när e-postmeddelandet skickas.

• reply_to: En lista eller tupel av mottagaradresser som används i ”Reply-To”-rubriken när e-postmeddelandet skickas.

• 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: En ordbok med extra rubriker som ska läggas till meddelandet. Nycklarna är rubriknamnet, värdena är rubrikvärdena. Det är upp till den som anropar att se till att rubriknamn och värden är i rätt format för ett e-postmeddelande. Motsvarande attribut är 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().

Till exempel:

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"},
)

Klassen har följande metoder:

send(fail_silently=False)Link to this definition#

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.

message(*, policy=email.policy.default)Link to this definition#

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.

recipients()Link to this definition#

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 to this definition#

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.

  Till exempel:

  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.

  För en mimetype som börjar med text/ förväntas innehållet vara en sträng. Binära data kommer att avkodas med UTF-8, och om det misslyckas kommer MIME-typen att ändras till application/octet-stream och data kommer att bifogas oförändrat.

• 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 to this definition#

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 to this definition#

En namngiven tupel för att lagra bilagor till ett e-postmeddelande.

Den namngivna tupeln har följande index:

• filnamn

• innehåll

• mimetype

Skicka alternativa innehållstyperLink to this heading#

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

Hämta en instans av en e-postbackendLink to this heading#

Funktionen get_connection() i django.core.mail returnerar en instans av e-postbackend som du kan använda.

get_connection(backend=None, *, fail_silently=False, **kwargs)Link to this definition#

Som standard kommer ett anrop till get_connection() att returnera en instans av den e-postbackend som anges i EMAIL_BACKEND. Om du anger argumentet backend kommer en instans av den backend att instansieras.

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.

Alla andra nyckelordsargument skickas direkt till konstruktören för e-postbackend.

Django levereras med flera backends för att skicka e-post. Med undantag för SMTP-backend (som är standard) är dessa backends endast användbara under testning och utveckling. Om du har speciella krav på att skicka e-post kan du skriva din egen e-postbackend.

EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"

EMAIL_BACKEND = "django.core.mail.backends.filebased.EmailBackend"
EMAIL_FILE_PATH = "/tmp/app-messages"  # change this to a proper location

EMAIL_BACKEND = "django.core.mail.backends.locmem.EmailBackend"

EMAIL_BACKEND = "django.core.mail.backends.dummy.EmailBackend"

Definiera en anpassad backend för e-postLink to this heading#

Om du behöver ändra hur e-postmeddelanden skickas kan du skriva din egen e-postbackend. Inställningen EMAIL_BACKEND i din inställningsfil är sedan Python-importsökvägen för din backend-klass.

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.

Skicka flera e-postmeddelandenLink to this heading#

Att upprätta och stänga en SMTP-anslutning (eller någon annan nätverksanslutning för den delen) är en dyr process. Om du har många e-postmeddelanden att skicka är det klokt att återanvända en SMTP-anslutning i stället för att skapa och förstöra en anslutning varje gång du vill skicka ett e-postmeddelande.

Det finns två sätt att tala om för en e-postbackend att den ska återanvända en anslutning.

För det första kan du använda metoden send_messages() på en anslutning. Detta tar en lista över EmailMessage (eller underklass) instanser, och skickar dem alla med hjälp av den enda anslutningen. Som en konsekvens ignoreras alla connection som anges för ett enskilt meddelande.

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)

I det här exemplet öppnar anropet till send_messages() en anslutning på backend, skickar listan med meddelanden och stänger sedan anslutningen igen.

Det andra tillvägagångssättet är att använda metoderna open() och close() på e-postbackend för att manuellt styra anslutningen. send_messages() öppnar eller stänger inte anslutningen manuellt om den redan är öppen, så om du öppnar anslutningen manuellt kan du styra när den ska stängas. Till exempel:

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()