""" Tools for sending email. """ import warnings from django.conf import settings from django.core.exceptions import ImproperlyConfigured # 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.message import ( DEFAULT_ATTACHMENT_MIME_TYPE, EmailAlternative, EmailAttachment, EmailMessage, EmailMultiAlternatives, forbid_multi_line_headers, make_msgid, ) from django.core.mail.utils import DNS_NAME, CachedDnsName from django.utils.deprecation import RemovedInDjango70Warning, deprecate_posargs from django.utils.functional import Promise from django.utils.module_loading import import_string __all__ = [ "CachedDnsName", "DNS_NAME", "EmailMessage", "EmailMultiAlternatives", "DEFAULT_ATTACHMENT_MIME_TYPE", "make_msgid", "get_connection", "send_mail", "send_mass_mail", "mail_admins", "mail_managers", "EmailAlternative", "EmailAttachment", # RemovedInDjango70Warning: When the deprecation ends, remove the last # entries. "BadHeaderError", "SafeMIMEText", "SafeMIMEMultipart", "forbid_multi_line_headers", ] @deprecate_posargs(RemovedInDjango70Warning, ["fail_silently"]) def get_connection(backend=None, *, fail_silently=False, **kwds): """Load an email backend and return an instance of it. If backend is None (default), use settings.EMAIL_BACKEND. Both fail_silently and other keyword arguments are used in the constructor of the backend. """ klass = import_string(backend or settings.EMAIL_BACKEND) return klass(fail_silently=fail_silently, **kwds) @deprecate_posargs( RemovedInDjango70Warning, [ "fail_silently", "auth_user", "auth_password", "connection", "html_message", ], ) def send_mail( subject, message, from_email, recipient_list, *, fail_silently=False, auth_user=None, auth_password=None, connection=None, html_message=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 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. """ if connection is not None: if fail_silently: raise TypeError( "fail_silently cannot be used with a connection. " "Pass fail_silently to get_connection() instead." ) if auth_user is not None or auth_password is not None: raise TypeError( "auth_user and auth_password cannot be used with a connection. " "Pass auth_user and auth_password to get_connection() instead." ) connection = connection or get_connection( username=auth_user, password=auth_password, fail_silently=fail_silently, ) mail = EmailMultiAlternatives( subject, message, from_email, recipient_list, connection=connection ) if html_message: mail.attach_alternative(html_message, "text/html") return mail.send() @deprecate_posargs( RemovedInDjango70Warning, [ "fail_silently", "auth_user", "auth_password", "connection", ], ) 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), send each message to each recipient list. Return the number of emails sent. 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. """ if connection is not None: if fail_silently: raise TypeError( "fail_silently cannot be used with a connection. " "Pass fail_silently to get_connection() instead." ) if auth_user is not None or auth_password is not None: raise TypeError( "auth_user and auth_password cannot be used with a connection. " "Pass auth_user and auth_password to get_connection() instead." ) connection = connection or get_connection( username=auth_user, password=auth_password, fail_silently=fail_silently, ) messages = [ EmailMessage(subject, message, sender, recipient, connection=connection) for subject, message, sender, recipient in datatuple ] return connection.send_messages(messages) def _send_server_message( *, setting_name, subject, message, html_message=None, fail_silently=False, connection=None, ): if connection is not None and fail_silently: raise TypeError( "fail_silently cannot be used with a connection. " "Pass fail_silently to get_connection() instead." ) recipients = getattr(settings, setting_name) if not recipients: return # RemovedInDjango70Warning. if all(isinstance(a, (list, tuple)) and len(a) == 2 for a in recipients): warnings.warn( f"Using (name, address) pairs in the {setting_name} setting is deprecated." " Replace with a list of email address strings.", RemovedInDjango70Warning, stacklevel=2, ) recipients = [a[1] for a in recipients] if not isinstance(recipients, (list, tuple)) or not all( isinstance(address, (str, Promise)) for address in recipients ): raise ImproperlyConfigured( f"The {setting_name} setting must be a list of email address strings." ) mail = EmailMultiAlternatives( subject="%s%s" % (settings.EMAIL_SUBJECT_PREFIX, subject), body=message, from_email=settings.SERVER_EMAIL, to=recipients, connection=connection, ) if html_message: mail.attach_alternative(html_message, "text/html") mail.send(fail_silently=fail_silently) @deprecate_posargs( RemovedInDjango70Warning, ["fail_silently", "connection", "html_message"] ) 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.""" _send_server_message( setting_name="ADMINS", subject=subject, message=message, html_message=html_message, fail_silently=fail_silently, connection=connection, ) @deprecate_posargs( RemovedInDjango70Warning, ["fail_silently", "connection", "html_message"] ) 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.""" _send_server_message( setting_name="MANAGERS", subject=subject, message=message, html_message=html_message, fail_silently=fail_silently, connection=connection, ) # RemovedInDjango70Warning. _deprecate_on_import = { "BadHeaderError": "BadHeaderError is deprecated. Replace with ValueError.", "SafeMIMEText": ( "SafeMIMEText is deprecated. The return value" " of EmailMessage.message() is an email.message.EmailMessage." ), "SafeMIMEMultipart": ( "SafeMIMEMultipart is deprecated. The return value" " of EmailMessage.message() is an email.message.EmailMessage." ), } # RemovedInDjango70Warning. def __getattr__(name): try: msg = _deprecate_on_import[name] except KeyError: raise AttributeError(f"module {__name__!r} has no attribute {name!r}") from None else: # Issue deprecation warnings at time of import. from django.core.mail import message warnings.warn(msg, category=RemovedInDjango70Warning) return getattr(message, name)