Django

Code

Ticket #4163 (closed: fixed)

Opened 1 year ago

Last modified 1 year ago

EMAIL_HOST_PASSWORD doc says it's a Username

Reported by: Karen Tracey <kmtracey@gmail.com> Assigned to: jacob
Milestone: Component: Documentation
Version: SVN Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

The documentation for EMAIL_HOST_PASSWORD states that it is the: "Username to use for the SMTP server defined in EMAIL_HOST. If empty, Django won’t attempt authentication." Shouldn't that be Password? Maybe something like:

Password to use for the SMTP server defined in EMAIL_HOST. This setting is used in conjunction with EMAIL_HOST_USER when authenticating to the SMTP server. If either of these settings is empty, Django won't attempt authenticaion.

(I actually didn't check the code to see if that last sentence is true; I'm not sure what the code does if one of these is empty but the other is not.)

I'd also suggest that it would be helpful if the send_mail documentation (http://www.djangoproject.com/documentation/email/) pointed to these settings. Not sure if that should be a different ticket?

Attachments

4163.diff (1.3 kB) - added by Karen Tracey <kmtracey@gmail.com> on 04/26/07 23:44:40.

Change History

04/26/07 17:23:33 changed by SmileyChris

  • needs_better_patch changed.
  • stage changed from Unreviewed to Accepted.
  • needs_tests changed.
  • needs_docs set to 1.

Thanks for the report, Karen.

I say this ticket can probably cover both issues. If you have the competence, a patch would be helpful!

04/26/07 23:44:40 changed by Karen Tracey <kmtracey@gmail.com>

  • attachment 4163.diff added.

04/26/07 23:51:12 changed by Karen Tracey <kmtracey@gmail.com>

  • needs_docs deleted.
  • has_patch set to 1.

Well I took a shot at it, though I'll admit I'm unfamiliar with the format of the documentation files (is it described somewhere? I couldn't find it.) So I just tried to match what I already saw being done there. Hopefully it's at least useful as a starting idea for what to change.

04/27/07 00:07:41 changed by SmileyChris

  • stage changed from Accepted to Ready for checkin.

Thanks Karen, great job! Better than a starting idea, I reckon that's about ready for checkin.

04/27/07 00:11:32 changed by SmileyChris

PS: The documentation format is restructured text

04/27/07 07:54:45 changed by Karen Tracey <kmtracey@gmail.com>

Thanks for the pointer, that'll come in handy for any future doc changes I might suggest. I also forgot to mention that I did verify that the one sentence I wasn't sure about above is a correct description of how the code works.

04/27/07 09:25:06 changed by mtredinnick

  • status changed from new to closed.
  • resolution set to fixed.

(In [5111]) Fixed #4163 -- Added some "quick notes" documentation about the configuration variables required to send email. Thanks, Karen Tracey.

Add/Change #4163 (EMAIL_HOST_PASSWORD doc says it's a Username)




Change Properties
Action