Opened 9 years ago

Closed 9 years ago

Last modified 9 years ago

#5615 closed (fixed)

Typo in email docs: "to" field should be a list

Reported by: raprasad@… Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: email to
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


documentation typo on:

The "to" address is not a list:

-fix 1-


subject, from_email, to = 'hello', '', ''


subject, from_email, to = 'hello', '', ['']

--- OR ---

-fix 2-

msg = EmailMultiAlternatives(subject, text_content, from_email, to)


msg = EmailMultiAlternatives(subject, text_content, from_email, [to])

Attachments (1)

5615.diff (605 bytes) - added by tvrg 9 years ago.

Download all attachments as: .zip

Change History (6)

Changed 9 years ago by tvrg

comment:1 Changed 9 years ago by tvrg

  • Has patch set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

I prefer the second fix since it is consistent with the next example

msg = EmailMessage(subject, html_content, from_email, [to])
msg.content_subtype = "html" # Main content is now text/html

feel free to disagree

comment:2 Changed 9 years ago by mboersma

  • Keywords email to added
  • Summary changed from typo in e-mail documenation: "to" address is a string, not a list to Typo in email docs: "to" field should be a list
  • Triage Stage changed from Unreviewed to Ready for checkin

The specific code that this ends up calling is the parent class EmailMessage.init, which does indeed expect a list as it does ','.join() on it soon afterward. I prefer the second fix as you have in your patch, too.

comment:3 Changed 9 years ago by raprasad@…


tvrg's patch looks good

comment:4 Changed 9 years ago by ubernostrum

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

(In [6431]) Fixed #5615: Corrected a typo in docs/email.txt. Thanks, raprasad@….

comment:5 Changed 9 years ago by anonymous


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