#29430: django.core.mail.send_mail()'s fail_silently kwarg is documented
incorrectly
--------------------------------+--------------------------------------
Reporter: ティン・ルーフ | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------+--------------------------------------
Description changed by ティン・ルーフ:
Old description:
> From https://docs.djangoproject.com/en/2.0/topics/email/#send-mail: “If
> it’s False, send_mail will raise an smtplib.SMTPException.”
>
> This is often untrue, and certainly misleading. Certainly, if it's False,
> send_mail is ''capable'' of raising SMTPException, but it's not
> guaranteed.
>
> I was going to open a pull request and change it to “If it's True,
> send_mail can raise smtplib.SMTPException”, but I'm not confident that
> other exceptions cannot be raised, or that send_mail will never raise
> SMTPException if fail_silently is True.
New description:
From https://docs.djangoproject.com/en/2.0/topics/email/#send-mail: “If
it’s False, send_mail will raise an smtplib.SMTPException.”
This is often untrue, and certainly misleading. Certainly, if it's False,
send_mail is ''capable'' of raising SMTPException, but it's not
guaranteed.
I was going to open a pull request and change it to “If it's True,
send_mail can raise smtplib.SMTPException”, but I'm not confident that
other exceptions cannot be raised, or that send_mail will never raise
SMTPException if fail_silently is True.
The main thing I would like would be for the intent of fail_silently to be
expressed; what kind of errors is it trying to suppress, for example? What
kind of emails could a Django site be sending that are unimportant enough
that failing silently is a good idea?
--
--
Ticket URL: <https://code.djangoproject.com/ticket/29430#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/066.0eb4e1bd47faa01cc478ee8f0f0be7ad%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
