def test_unsuccessful_status_codes_raises_exception(self):
"""Test that unsuccessful status codes returned raises an exception."""
email_exception = self.assertRaisesRegexp(
Exception, 'Bulk email failed to send. Please try again later or' +
' contact us to report a bug at https://www.oppia.org/contact.')
allow_emailing = self.swap(feconf, 'CAN_SEND_EMAILS', True)
swap_send_email_to_recipients = self.swap(
platform_email_services, 'send_email_to_recipients',
lambda *_: False)
recipients = [feconf.ADMIN_EMAIL_ADDRESS]
with allow_emailing, email_exception, swap_send_email_to_recipients:
email_services.send_bulk_mail(
feconf.SYSTEM_EMAIL_ADDRESS, recipients,
'subject', 'body', 'html')
email_exception = self.assertRaisesRegexp(
Exception, (
'Email to %s failed to send. Please try again later or ' +
'contact us to report a bug at ' +
'https://www.oppia.org/contact.') % feconf.ADMIN_EMAIL_ADDRESS)
allow_emailing = self.swap(feconf, 'CAN_SEND_EMAILS', True)
swap_send_email_to_recipients = self.swap(
platform_email_services, 'send_email_to_recipients',
lambda *_: False)
with allow_emailing, email_exception, swap_send_email_to_recipients:
email_services.send_mail(
feconf.SYSTEM_EMAIL_ADDRESS, feconf.ADMIN_EMAIL_ADDRESS,
'subject', 'body', 'html', bcc_admin=True)
def test_send_mail_raises_exception_for_invalid_permissions(self):
"""Tests the send_mail exception raised for invalid user permissions."""
send_email_exception = (
self.assertRaisesRegexp(
Exception, 'This app cannot send emails to users.'))
with send_email_exception, self.swap(constants, 'DEV_MODE', False):
email_services.send_mail(
feconf.SYSTEM_EMAIL_ADDRESS, feconf.ADMIN_EMAIL_ADDRESS,
'subject', 'body', 'html', bcc_admin=False)
def test_bcc_admin_flag(self):
"""Verifies that the bcc admin flag is working properly in
send_mail.
"""
allow_emailing = self.swap(feconf, 'CAN_SEND_EMAILS', True)
with allow_emailing:
email_services.send_mail(
feconf.SYSTEM_EMAIL_ADDRESS, feconf.ADMIN_EMAIL_ADDRESS,
'subject', 'body', 'html', bcc_admin=True)
messages = self._get_sent_email_messages(feconf.ADMIN_EMAIL_ADDRESS)
self.assertEqual(len(messages), 1)
self.assertEqual(messages[0].bcc, feconf.ADMIN_EMAIL_ADDRESS)
def test_send_mail_data_properly_sent(self):
"""Verifies that the data sent in send_mail is correct."""
allow_emailing = self.swap(feconf, 'CAN_SEND_EMAILS', True)
with allow_emailing:
email_services.send_mail(
feconf.SYSTEM_EMAIL_ADDRESS, feconf.ADMIN_EMAIL_ADDRESS,
'subject', 'body', 'html', bcc_admin=False)
messages = self._get_sent_email_messages(feconf.ADMIN_EMAIL_ADDRESS)
self.assertEqual(len(messages), 1)
self.assertEqual(messages[0].subject, 'subject')
self.assertEqual(messages[0].body, 'body')
self.assertEqual(messages[0].html, 'html')
def test_email_not_sent_if_email_addresses_are_malformed(self):
"""Tests that email is not sent if recipient email address is
malformed.
"""
# Case when malformed_recipient_email is None when calling send_mail.
malformed_recipient_email = None
email_exception = self.assertRaisesRegexp(
ValueError, 'Malformed recipient email address: %s'
% malformed_recipient_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_mail(
'*****@*****.**', malformed_recipient_email,
'subject', 'body', 'html')
# Case when malformed_recipient_email is an empty string when
# calling send_mail.
malformed_recipient_email = ''
email_exception = self.assertRaisesRegexp(
ValueError, 'Malformed recipient email address: %s'
% malformed_recipient_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_mail(
'*****@*****.**', malformed_recipient_email,
'subject', 'body', 'html')
# Case when sender is malformed for send_mail.
malformed_sender_email = 'x@x@x'
email_exception = self.assertRaisesRegexp(
ValueError, 'Malformed sender email address: %s'
% malformed_sender_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_mail(
malformed_sender_email, '*****@*****.**',
'subject', 'body', 'html')
# Case when the SENDER_EMAIL in brackets of 'SENDER NAME <SENDER_EMAIL>
# is malformed when calling send_mail.
malformed_sender_email = 'Name <malformed_email>'
email_exception = self.assertRaisesRegexp(
ValueError, 'Malformed sender email address: %s'
% malformed_sender_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_mail(
malformed_sender_email, '*****@*****.**',
'subject', 'body', 'html')
# Case when sender is malformed when calling send_bulk_mail.
malformed_sender_email = 'name [email protected]'
email_exception = self.assertRaisesRegexp(
ValueError, 'Malformed sender email address: %s'
% malformed_sender_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_bulk_mail(
malformed_sender_email, ['*****@*****.**'],
'subject', 'body', 'html')
# Case when sender is malformed when calling send_bulk_mail.
malformed_recipient_emails = ['*****@*****.**', 'email.com']
email_exception = self.assertRaisesRegexp(
ValueError, 'Malformed recipient email address: %s'
% malformed_recipient_emails[1])
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_bulk_mail(
'*****@*****.**', malformed_recipient_emails,
'subject', 'body', 'html')
def test_email_not_sent_if_email_addresses_are_malformed(self) -> None:
"""Tests that email is not sent if recipient email address is
malformed.
"""
# Case when malformed_recipient_email is None when calling send_mail.
malformed_recipient_email = None
email_exception = self.assertRaisesRegex( # type: ignore[no-untyped-call]
ValueError, 'Malformed recipient email address: %s' %
malformed_recipient_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
# TODO(#13528): Remove this test after the backend is fully
# type-annotated. send_mail() method doesn't expect recipient_email
# to be None, and the case when the recipient_email is malformed
# must be tested this is why ignore[arg-type] is used here.
email_services.send_mail(
'*****@*****.**',
malformed_recipient_email, # type: ignore[arg-type]
'subject',
'body',
'html')
# Case when malformed_recipient_email is an empty string when
# calling send_mail.
malformed_recipient_email = ''
email_exception = self.assertRaisesRegex( # type: ignore[no-untyped-call]
ValueError, 'Malformed recipient email address: %s' %
malformed_recipient_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_mail('*****@*****.**',
malformed_recipient_email, 'subject',
'body', 'html')
# Case when sender is malformed for send_mail.
malformed_sender_email = 'x@x@x'
email_exception = self.assertRaisesRegex( # type: ignore[no-untyped-call]
ValueError,
'Malformed sender email address: %s' % malformed_sender_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_mail(malformed_sender_email,
'*****@*****.**', 'subject',
'body', 'html')
# Case when the SENDER_EMAIL in brackets of 'SENDER NAME <SENDER_EMAIL>
# is malformed when calling send_mail.
malformed_sender_email = 'Name <malformed_email>'
email_exception = self.assertRaisesRegex( # type: ignore[no-untyped-call]
ValueError,
'Malformed sender email address: %s' % malformed_sender_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_mail(malformed_sender_email,
'*****@*****.**', 'subject',
'body', 'html')
# Case when sender is malformed when calling send_bulk_mail.
malformed_sender_email = 'name [email protected]'
email_exception = self.assertRaisesRegex( # type: ignore[no-untyped-call]
ValueError,
'Malformed sender email address: %s' % malformed_sender_email)
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_bulk_mail(malformed_sender_email,
['*****@*****.**'], 'subject',
'body', 'html')
# Case when sender is malformed when calling send_bulk_mail.
malformed_recipient_emails = ['*****@*****.**', 'email.com']
email_exception = self.assertRaisesRegex( # type: ignore[no-untyped-call]
ValueError, 'Malformed recipient email address: %s' %
malformed_recipient_emails[1])
with self.swap(feconf, 'CAN_SEND_EMAILS', True), email_exception:
email_services.send_bulk_mail('*****@*****.**',
malformed_recipient_emails,
'subject', 'body', 'html')