django.core.mail.EmailMessage

class documentation

class EmailMessage: (source)

Known subclasses: django.core.mail.EmailMultiAlternatives

View In Hierarchy

A container for email information.

Method __init__ Initialize a single email message (which can be sent to multiple recipients).
Method attach Attach a file with the given filename and content. The filename can be omitted and the mimetype is guessed, if not provided.
Method attach_file Attach a file from the filesystem.
Method get_connection Undocumented
Method message Undocumented
Method recipients Return a list of all recipients of the email (includes direct addressees as well as Cc and Bcc entries).
Method send Send the email message.
Class Variable content_subtype Undocumented
Class Variable encoding Undocumented
Class Variable mixed_subtype Undocumented
Instance Variable attachments Undocumented
Instance Variable bcc Undocumented
Instance Variable body Undocumented
Instance Variable cc Undocumented
Instance Variable connection Undocumented
Instance Variable extra_headers Undocumented
Instance Variable from_email Undocumented
Instance Variable reply_to Undocumented
Instance Variable subject Undocumented
Instance Variable to Undocumented
Method _create_attachment Convert the filename, content, mimetype triple into a MIME attachment object.
Method _create_attachments Undocumented
Method _create_message Undocumented
Method _create_mime_attachment Convert the content, mimetype pair into a MIME attachment object.
Method _set_list_header_if_not_empty Set msg's header, either from self.extra_headers, if present, or from the values argument.
def __init__(self, subject='', body='', from_email=None, to=None, bcc=None, connection=None, attachments=None, headers=None, cc=None, reply_to=None): (source)
overridden in django.core.mail.EmailMultiAlternatives

Initialize a single email message (which can be sent to multiple recipients).

def attach(self, filename=None, content=None, mimetype=None): (source)

Attach a file with the given filename and content. The filename can be omitted and the mimetype is guessed, if not provided. If the first parameter is a MIMEBase subclass, insert it directly into the resulting message attachments. For a text/* mimetype (guessed or specified), when a bytes object is specified as content, decode it as UTF-8. If that fails, set the mimetype to DEFAULT_ATTACHMENT_MIME_TYPE and don't decode the content.

def attach_file(self, path, mimetype=None): (source)

Attach a file from the filesystem. Set the mimetype to DEFAULT_ATTACHMENT_MIME_TYPE if it isn't specified and cannot be guessed. For a text/* mimetype (guessed or specified), decode the file's content as UTF-8. If that fails, set the mimetype to DEFAULT_ATTACHMENT_MIME_TYPE and don't decode the content.

def get_connection(self, fail_silently=False): (source)

Undocumented

def message(self): (source)

Undocumented

def recipients(self): (source)

Return a list of all recipients of the email (includes direct addressees as well as Cc and Bcc entries).

def send(self, fail_silently=False): (source)

Send the email message.

content_subtype: str = (source)

Undocumented

encoding = (source)

Undocumented

mixed_subtype: str = (source)

Undocumented

attachments: list = (source)

Undocumented

bcc = (source)

Undocumented

body = (source)

Undocumented

cc = (source)

Undocumented

connection = (source)

Undocumented

extra_headers = (source)

Undocumented

from_email = (source)

Undocumented

reply_to = (source)

Undocumented

subject = (source)

Undocumented

to = (source)

Undocumented

def _create_attachment(self, filename, content, mimetype=None): (source)

Convert the filename, content, mimetype triple into a MIME attachment object.

def _create_attachments(self, msg): (source)

Undocumented

def _create_message(self, msg): (source)
overridden in django.core.mail.EmailMultiAlternatives

Undocumented

def _create_mime_attachment(self, content, mimetype): (source)

Convert the content, mimetype pair into a MIME attachment object. If the mimetype is message/rfc822, content may be an email.Message or EmailMessage object, as well as a str.

def _set_list_header_if_not_empty(self, msg, header, values): (source)

Set msg's header, either from self.extra_headers, if present, or from the values argument.