Module mail

Re-exported Classes

• class BadHeaderError
  [django.core.mail.message.BadHeaderError]
• class CachedDnsName
  [django.core.mail.utils.CachedDnsName]
• class EmailMessage
  A container for email information.
  [django.core.mail.message.EmailMessage]
• class EmailMultiAlternatives
  A version of EmailMessage that makes it easy to send multipart/alternative messages. For example, including text and HTML versions of the text is made easier.
  [django.core.mail.message.EmailMultiAlternatives]
• class SafeMIMEMultipart
  [django.core.mail.message.SafeMIMEMultipart]
• class SafeMIMEText
  [django.core.mail.message.SafeMIMEText]

Functions

• ▶ def get_connection(backend=None, fail_silently=False, **kwds)

  Load an email backend and return an instance of it.

  source link

  If backend is None (default), use settings.EMAIL_BACKEND.
  
  Both fail_silently and other keyword arguments are used in the
  constructor of the backend.

  Reexports

  • Imported in django.utils.log.
• ▶ def mail_admins(subject, message, fail_silently=False, connection=None, html_message=None)

  Send a message to the admins, as defined by the ADMINS setting.

  source link

  Reexports

  • Imported in django.core.management.commands.sendtestemail.
• ▶ def mail_managers(subject, message, fail_silently=False, connection=None, html_message=None)

  Send a message to the managers, as defined by the MANAGERS setting.

  source link

  Reexports

  • Imported in django.core.management.commands.sendtestemail.
  • Imported in django.middleware.common.
• ▶ def send_mail(subject, message, from_email, recipient_list, fail_silently=False, ...)

  Easy wrapper for sending a single message to a recipient list. All members of the recipient list will see the other recipients in the 'To' field.

  def send_mail(

  subject,

  message,

  from_email,

  recipient_list,

  fail_silently=False,

  auth_user=None,

  auth_password=None,

  connection=None,

  html_message=None,

  )

  source link

  If from_email is None, use the DEFAULT_FROM_EMAIL setting.
  If auth_user is None, use the EMAIL_HOST_USER setting.
  If auth_password is None, use the EMAIL_HOST_PASSWORD setting.
  
  Note: The API for this method is frozen. New code wanting to extend the
  functionality should use the EmailMessage class directly.

  Reexports

  • Imported in django.contrib.auth.models.
  • Imported in django.core.management.commands.sendtestemail.
• ▶ def send_mass_mail(datatuple, fail_silently=False, auth_user=None, auth_password=None, ...)

  Given a datatuple of (subject, message, from_email, recipient_list), send each message to each recipient list. Return the number of emails sent.

  def send_mass_mail(

  datatuple,

  fail_silently=False,

  auth_user=None,

  auth_password=None,

  connection=None,

  )

  source link

  If from_email is None, use the DEFAULT_FROM_EMAIL setting.
  If auth_user and auth_password are set, use them to log in.
  If auth_user is None, use the EMAIL_HOST_USER setting.
  If auth_password is None, use the EMAIL_HOST_PASSWORD setting.
  
  Note: The API for this method is frozen. New code wanting to extend the
  functionality should use the EmailMessage class directly.

Re-exported Functions

• def forbid_multi_line_headers(name, val, encoding)
  Forbid multi-line headers to prevent header injection.
  [django.core.mail.message.forbid_multi_line_headers]

Submodules

• Module django.core.mail.backends
• Module django.core.mail.message
• Module django.core.mail.utils
  Email message and email sending related helper functions.

Generated by nedoc v0.9 at 2020-12-29 14:04