Skip to content

gh-136191: Unify commands to uppercase for wider support #136733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −15
Open

gh-136191: Unify commands to uppercase for wider support #136733

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions Lib/smtplib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
'''SMTP/ESMTP client class.

This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP
Authentication) and RFC 2487 (Secure SMTP over TLS).
This should follow RFC 5321 (SMTP which obsoletes RFC 821), RFC 1869
(ESMTP), RFC 2554 (SMTP Authentication) and RFC 2487 (Secure SMTP
over TLS).

Notes:

Expand Down Expand Up @@ -36,6 +37,8 @@
# Better RFC 821 compliance (MAIL and RCPT, and CRLF in data)
# by Carey Evans <c.evans@clear.net.nz>, for picky mail servers.
# RFC 2554 (authentication) support by Gerhard Haering <gerhard@bigfoot.de>.
# Upper case commands for wider support as enumerated in section 2.4 of RFC 5321
# by Steve Jacob <steve@mymangomail.com>
Comment on lines +40 to +41
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some change logs in a module's source code, but usually we don't update them nowadays. Instead, we mention them in the news entry (where the PR author's name can also be credited).

#
# This was modified from the Python 1.5 library HTTP lib.

Expand Down Expand Up @@ -219,7 +222,7 @@ class SMTP:
sock = None
file = None
helo_resp = None
ehlo_msg = "ehlo"
ehlo_msg = "EHLO"
ehlo_resp = None
does_esmtp = False
default_port = SMTP_PORT
Expand Down Expand Up @@ -435,7 +438,7 @@ def helo(self, name=''):
Hostname to send for this command defaults to the FQDN of the local
host.
"""
self.putcmd("helo", name or self.local_hostname)
self.putcmd("HELO", name or self.local_hostname)
(code, msg) = self.getreply()
self.helo_resp = msg
return (code, msg)
Expand Down Expand Up @@ -498,13 +501,13 @@ def has_extn(self, opt):
def help(self, args=''):
"""SMTP 'help' command.
Returns help text from server."""
self.putcmd("help", args)
self.putcmd("HELP", args)
return self.getreply()[1]

def rset(self):
"""SMTP 'rset' command -- resets session."""
self.command_encoding = 'ascii'
return self.docmd("rset")
return self.docmd("RSET")

def _rset(self):
"""Internal 'rset' command which ignores any SMTPServerDisconnected error.
Expand All @@ -520,7 +523,7 @@ def _rset(self):

def noop(self):
"""SMTP 'noop' command -- doesn't do anything :>"""
return self.docmd("noop")
return self.docmd("NOOP")

def mail(self, sender, options=()):
"""SMTP 'mail' command -- begins mail xfer session.
Expand All @@ -540,15 +543,15 @@ def mail(self, sender, options=()):
raise SMTPNotSupportedError(
'SMTPUTF8 not supported by server')
optionlist = ' ' + ' '.join(options)
self.putcmd("mail", "from:%s%s" % (quoteaddr(sender), optionlist))
self.putcmd("MAIL", "FROM:%s%s" % (quoteaddr(sender), optionlist))
return self.getreply()

def rcpt(self, recip, options=()):
"""SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
optionlist = ''
if options and self.does_esmtp:
optionlist = ' ' + ' '.join(options)
self.putcmd("rcpt", "to:%s%s" % (quoteaddr(recip), optionlist))
self.putcmd("RCPT", "TO:%s%s" % (quoteaddr(recip), optionlist))
return self.getreply()

def data(self, msg):
Expand All @@ -561,7 +564,7 @@ def data(self, msg):
is a string, lone '\\r' and '\\n' characters are converted to
'\\r\\n' characters. If msg is bytes, it is transmitted as is.
"""
self.putcmd("data")
self.putcmd("DATA")
(code, repl) = self.getreply()
if self.debuglevel > 0:
self._print_debug('data:', (code, repl))
Expand All @@ -582,14 +585,14 @@ def data(self, msg):

def verify(self, address):
"""SMTP 'verify' command -- checks for address validity."""
self.putcmd("vrfy", _addr_only(address))
self.putcmd("VRFY", _addr_only(address))
return self.getreply()
# a.k.a.
vrfy = verify

def expn(self, address):
"""SMTP 'expn' command -- expands a mailing list."""
self.putcmd("expn", _addr_only(address))
self.putcmd("EXPN", _addr_only(address))
return self.getreply()

# some useful methods
Expand Down Expand Up @@ -862,7 +865,7 @@ def sendmail(self, from_addr, to_addrs, msg, mail_options=(),
msg = _fix_eols(msg).encode('ascii')
if self.does_esmtp:
if self.has_extn('size'):
esmtp_opts.append("size=%d" % len(msg))
esmtp_opts.append("SIZE=%d" % len(msg))
for option in mail_options:
esmtp_opts.append(option)
(code, resp) = self.mail(from_addr, esmtp_opts)
Expand Down Expand Up @@ -988,7 +991,7 @@ def close(self):

def quit(self):
"""Terminate the SMTP session."""
res = self.docmd("quit")
res = self.docmd("QUIT")
# A new EHLO is required after reconnecting with connect()
self.ehlo_resp = self.helo_resp = None
self.esmtp_features = {}
Expand Down Expand Up @@ -1049,7 +1052,7 @@ class LMTP(SMTP):
using a Unix socket, LMTP generally don't support or require any
authentication, but your mileage might vary."""

ehlo_msg = "lhlo"
ehlo_msg = "LHLO"

def __init__(self, host='', port=LMTP_PORT, local_hostname=None,
source_address=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Expand Down
Loading