Issue 22301: smtplib.SMTP.starttls' documentation is just confusing (original) (raw)

Created on 2014-08-29 20:33 by maker, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (6)
msg226074 - (view)	Author: Michele Orrù (maker) *	Date: 2014-08-29 20:33
hello! In <https://docs.python.org/2/library/smtplib.html#smtplib.SMTP.starttls> I read:: "If keyfile and certfile are provided, these are passed to the socket module’s ssl() function." socket.ssl() exists, though it is not documented (not even in /dev/library/socket) and furthermore, the link on ssl() points to the ssl module, which is just confusing. maker: open an issue. (I'm noising ap and chris because afaik they were working on the latest ssl security stuff)
msg226075 - (view)	Author: Alex Gaynor (alex) *	Date: 2014-08-29 20:35
Attached patch fixes this up.
msg226080 - (view)	Author: Antoine Pitrou (pitrou) *	Date: 2014-08-29 20:50
Or perhaps we should remove the function to wrap_socket(), which is just an implementation detail?
msg226083 - (view)	Author: R. David Murray (r.david.murray) *	Date: 2014-08-29 20:56
Remove the reference, you mean? As in just delete the confusing line? Since we want to encourage people to use the context, that sounds reasonable for 3.x at least.
msg226242 - (view)	Author: Michele Orrù (maker) *	Date: 2014-09-01 19:57
"R. David Murray" <report@bugs.python.org> writes: > Since we want to encourage people to use the context, that sounds > reasonable for 3.x at least. Concerning this specific proposition, I really don't see the point in having .starttls() not simply accepting a SSLContext as argument, as imaplib.IMAP4.starttls is already doing, for example.
msg275035 - (view)	Author: Christian Heimes (christian.heimes) *	Date: 2016-09-08 15:02
starttls() does accept a ssl_context argument for a while.