111 lines
4.6 KiB
Python
111 lines
4.6 KiB
Python
"""
|
|
Tools for sending email.
|
|
"""
|
|
|
|
from django.conf import settings
|
|
from django.core.exceptions import ImproperlyConfigured
|
|
from django.utils.importlib import import_module
|
|
|
|
# Imported for backwards compatibility, and for the sake
|
|
# of a cleaner namespace. These symbols used to be in
|
|
# django/core/mail.py before the introduction of email
|
|
# backends and the subsequent reorganization (See #10355)
|
|
from django.core.mail.utils import CachedDnsName, DNS_NAME
|
|
from django.core.mail.message import \
|
|
EmailMessage, EmailMultiAlternatives, \
|
|
SafeMIMEText, SafeMIMEMultipart, \
|
|
DEFAULT_ATTACHMENT_MIME_TYPE, make_msgid, \
|
|
BadHeaderError, forbid_multi_line_headers
|
|
from django.core.mail.backends.smtp import EmailBackend as _SMTPConnection
|
|
|
|
def get_connection(backend=None, fail_silently=False, **kwds):
|
|
"""Load an e-mail backend and return an instance of it.
|
|
|
|
If backend is None (default) settings.EMAIL_BACKEND is used.
|
|
|
|
Both fail_silently and other keyword arguments are used in the
|
|
constructor of the backend.
|
|
"""
|
|
path = backend or settings.EMAIL_BACKEND
|
|
try:
|
|
mod = import_module(path)
|
|
except ImportError, e:
|
|
raise ImproperlyConfigured(('Error importing email backend %s: "%s"'
|
|
% (path, e)))
|
|
try:
|
|
cls = getattr(mod, 'EmailBackend')
|
|
except AttributeError:
|
|
raise ImproperlyConfigured(('Module "%s" does not define a '
|
|
'"EmailBackend" class' % path))
|
|
return cls(fail_silently=fail_silently, **kwds)
|
|
|
|
|
|
def send_mail(subject, message, from_email, recipient_list,
|
|
fail_silently=False, auth_user=None, auth_password=None,
|
|
connection=None):
|
|
"""
|
|
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.
|
|
|
|
If auth_user is None, the EMAIL_HOST_USER setting is used.
|
|
If auth_password is None, the EMAIL_HOST_PASSWORD setting is used.
|
|
|
|
Note: The API for this method is frozen. New code wanting to extend the
|
|
functionality should use the EmailMessage class directly.
|
|
"""
|
|
connection = connection or get_connection(username=auth_user,
|
|
password=auth_password,
|
|
fail_silently=fail_silently)
|
|
return EmailMessage(subject, message, from_email, recipient_list,
|
|
connection=connection).send()
|
|
|
|
|
|
def send_mass_mail(datatuple, fail_silently=False, auth_user=None,
|
|
auth_password=None, connection=None):
|
|
"""
|
|
Given a datatuple of (subject, message, from_email, recipient_list), sends
|
|
each message to each recipient list. Returns the number of e-mails sent.
|
|
|
|
If from_email is None, the DEFAULT_FROM_EMAIL setting is used.
|
|
If auth_user and auth_password are set, they're used to log in.
|
|
If auth_user is None, the EMAIL_HOST_USER setting is used.
|
|
If auth_password is None, the EMAIL_HOST_PASSWORD setting is used.
|
|
|
|
Note: The API for this method is frozen. New code wanting to extend the
|
|
functionality should use the EmailMessage class directly.
|
|
"""
|
|
connection = connection or get_connection(username=auth_user,
|
|
password=auth_password,
|
|
fail_silently=fail_silently)
|
|
messages = [EmailMessage(subject, message, sender, recipient)
|
|
for subject, message, sender, recipient in datatuple]
|
|
return connection.send_messages(messages)
|
|
|
|
|
|
def mail_admins(subject, message, fail_silently=False, connection=None):
|
|
"""Sends a message to the admins, as defined by the ADMINS setting."""
|
|
if not settings.ADMINS:
|
|
return
|
|
EmailMessage(settings.EMAIL_SUBJECT_PREFIX + subject, message,
|
|
settings.SERVER_EMAIL, [a[1] for a in settings.ADMINS],
|
|
connection=connection).send(fail_silently=fail_silently)
|
|
|
|
|
|
def mail_managers(subject, message, fail_silently=False, connection=None):
|
|
"""Sends a message to the managers, as defined by the MANAGERS setting."""
|
|
if not settings.MANAGERS:
|
|
return
|
|
EmailMessage(settings.EMAIL_SUBJECT_PREFIX + subject, message,
|
|
settings.SERVER_EMAIL, [a[1] for a in settings.MANAGERS],
|
|
connection=connection).send(fail_silently=fail_silently)
|
|
|
|
|
|
class SMTPConnection(_SMTPConnection):
|
|
def __init__(self, *args, **kwds):
|
|
import warnings
|
|
warnings.warn(
|
|
'mail.SMTPConnection is deprecated; use mail.get_connection() instead.',
|
|
PendingDeprecationWarning
|
|
)
|
|
super(SMTPConnection, self).__init__(*args, **kwds)
|