Opened 9 years ago

Closed 9 years ago

#4163 closed (fixed)

EMAIL_HOST_PASSWORD doc says it's a Username

Reported by: Karen Tracey <kmtracey@…> Owned by: jacob
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


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 ( pointed to these settings. Not sure if that should be a different ticket?

Attachments (1)

4163.diff (1.3 KB) - added by Karen Tracey <kmtracey@…> 9 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 9 years ago by SmileyChris

  • Needs documentation set
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Thanks for the report, Karen.

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

Changed 9 years ago by Karen Tracey <kmtracey@…>

comment:2 Changed 9 years ago by Karen Tracey <kmtracey@…>

  • Has patch set
  • Needs documentation unset

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.

comment:3 Changed 9 years ago by SmileyChris

  • Triage 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.

comment:4 Changed 9 years ago by SmileyChris

PS: The documentation format is restructured text

comment:5 Changed 9 years ago by Karen Tracey <kmtracey@…>

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.

comment:6 Changed 9 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from new to closed

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

Note: See TracTickets for help on using tickets.
Back to Top