paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-01 20:44:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

send_email: Show more information about messages which failed to send.

Browse Source
This commit is contained in:
Alex Vandiver
2021-05-11 11:24:52 -10:00
committed by Alex Vandiver
parent feb7870db7
commit 237efdee6c
2 changed files with 58 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
zerver/lib/send_email.py
View File

@@ -252,10 +252,22 @@ def send_email(
# This will call .open() for us, which is a no-op if it's already open;
# it will only call .close() if it was not open to begin with
if connection.send_messages([mail]) == 0:
logger.error("Error sending %s email to %s", template, mail.to)
logger.error("Unknown error sending %s email to %s", template, mail.to)
raise EmailNotDeliveredException
except smtplib.SMTPException:
logger.error("Error sending %s email to %s", template, mail.to)
except smtplib.SMTPResponseException as e:
logger.exception(
"Error sending %s email to %s with error code %s: %s",
template,
mail.to,
e.smtp_code,
e.smtp_error,
stack_info=True,
)
raise EmailNotDeliveredException
except smtplib.SMTPException as e:
logger.exception(
"Error sending %s email to %s: %s", template, mail.to, str(e), stack_info=True
)
raise EmailNotDeliveredException

57
zerver/tests/test_send_email.py
View File

@@ -1,4 +1,4 @@
from smtplib import SMTP, SMTPDataError, SMTPException
from smtplib import SMTP, SMTPDataError, SMTPException, SMTPRecipientsRefused
from unittest import mock
from django.core.mail.backends.locmem import EmailBackend
@@ -60,11 +60,39 @@ class TestBuildEmail(ZulipTestCase):
)
self.assertEqual(len(info_log.records), 2)
self.assertEqual(
info_log.output,
[
f"INFO:{logger.name}:Sending password_reset email to {mail.to}",
f"ERROR:{logger.name}:Error sending password_reset email to {mail.to}",
],
info_log.output[0], f"INFO:{logger.name}:Sending password_reset email to {mail.to}"
)
self.assertTrue(
info_log.output[1].startswith(
f"ERROR:{logger.name}:Error sending password_reset email to {mail.to} with error code 242: From field too long."
)
)
def test_build_and_send_refused(self) -> None:
hamlet = self.example_user("hamlet")
address = "zulip@example.com"
with mock.patch.object(
EmailBackend,
"send_messages",
side_effect=SMTPRecipientsRefused(recipients={address: (550, b"User unknown")}),
):
with self.assertLogs(logger=logger) as info_log:
with self.assertRaises(EmailNotDeliveredException):
send_email(
"zerver/emails/password_reset",
to_emails=[hamlet],
from_name="Zulip",
from_address=address,
language="en",
)
self.assertEqual(len(info_log.records), 2)
self.assertEqual(
info_log.output[0], f"INFO:{logger.name}:Sending password_reset email to {[hamlet]}"
)
self.assertFalse(
info_log.output[1].startswith(
f"ERROR:{logger.name}:Error sending password_reset email to {[hamlet]}: {{'{address}': (550, 'User unknown')}}"
)
)
@@ -119,10 +147,13 @@ class TestSendEmail(ZulipTestCase):
)
# We test the two cases that should raise an EmailNotDeliveredException
side_effect = [0, SMTPException]
errors = {
f"Unknown error sending password_reset email to {mail.to}": [0],
f"Error sending password_reset email to {mail.to}": [SMTPException()],
}
with mock.patch.object(EmailBackend, "send_messages", side_effect=side_effect):
for i in range(len(side_effect)):
for message, side_effect in errors.items():
with mock.patch.object(EmailBackend, "send_messages", side_effect=side_effect):
with self.assertLogs(logger=logger) as info_log:
with self.assertRaises(EmailNotDeliveredException):
send_email(
@@ -134,9 +165,7 @@ class TestSendEmail(ZulipTestCase):
)
self.assertEqual(len(info_log.records), 2)
self.assertEqual(
info_log.output,
[
f"INFO:{logger.name}:Sending password_reset email to {mail.to}",
f"ERROR:{logger.name}:Error sending password_reset email to {mail.to}",
],
info_log.output[0],
f"INFO:{logger.name}:Sending password_reset email to {mail.to}",
)
self.assertTrue(info_log.output[1].startswith(f"ERROR:zulip.send_email:{message}"))