Skip to content

bpo-28879 : add date if missing in smtplib.send_message #2655

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

Closed
elafontaine wants to merge 6 commits into from
Closed

bpo-28879 : add date if missing in smtplib.send_message #2655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
943ee6e
bpo-28879 : add date if missing in smtplib.send_message
elafontaine Jul 11, 2017
9a8cdc2
bpo-28879 : add date if missing in smtplib.send_message part 2
elafontaine Jul 11, 2017
0c43644
bpo-28879 : Mock the date on the Test Case + Fix Typo
elafontaine Jul 20, 2017
aaefe85
bpo-28879 : Fix test case with less '\'
elafontaine Jul 20, 2017
9c1a121
bpo-28879 : escape the date example string
elafontaine Aug 3, 2017
178bc12
Adding news file to advertise changes done by this PR.
Jan 13, 2018
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
4 changes: 3 additions & 1 deletion Doc/library/smtplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,9 @@ An :class:`SMTP` instance has the following methods:
specified in :rfc:`5322`\: *from_addr* is set to the :mailheader:`Sender`
field if it is present, and otherwise to the :mailheader:`From` field.
*to_addrs* combines the values (if any) of the :mailheader:`To`,
:mailheader:`Cc`, and :mailheader:`Bcc` fields from *msg*. If exactly one
:mailheader:`Cc`, and :mailheader:`Bcc` fields from *msg*. If there's no
*Date* header inside the message, ``send_message`` will add one to the data.
If exactly one
set of :mailheader:`Resent-*` headers appear in the message, the regular
headers are ignored and the :mailheader:`Resent-*` headers are used instead.
If the message contains more than one set of :mailheader:`Resent-*` headers,
Expand Down
5 changes: 5 additions & 0 deletions Lib/smtplib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,6 +928,11 @@ def send_message(self, msg, from_addr=None, to_addrs=None,
header_prefix = 'Resent-'
else:
raise ValueError("message has more than one 'Resent-' header block")

# RFC 5322 section 3.6, 4th Paragraph
if msg.get('Date', None) is None:
msg['Date'] = email.utils.formatdate()

if from_addr is None:
# Prefer the sender field per RFC 2822:3.6.2.
from_addr = (msg[header_prefix + 'Sender']
Expand Down
31 changes: 31 additions & 0 deletions Lib/test/test_smtplib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import textwrap

import unittest
from unittest.mock import patch
from test import support, mock_socket

try:
Expand Down Expand Up @@ -549,6 +550,36 @@ def testSendMessageMultipleResentRaises(self):
smtp.send_message(m)
smtp.close()

@patch('email.utils.formatdate')
def testSendMessageAddDateIfMissing(self, mocked_date_obj):
current_date = 'Thu, 1 Jan 1970 17:42:00 +0000'
mocked_date_obj.return_value = current_date
m = email.mime.text.MIMEText('A test message')
m['From'] = 'foo@bar.com'
m['To'] = 'John'
m['CC'] = 'Sally, Fred'
m['Bcc'] = 'John Root <root@localhost>, "Dinsdale" <warped@silly.walks.com>'
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
smtp.send_message(m)
Copy link
Contributor

@mlouielu mlouielu Jul 12, 2017

Choose a reason for hiding this comment

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

Maybe we can mock up the email.utils.formatdate() to ensure we have the same result to tests.

# XXX (see comment in testSend)
time.sleep(0.01)
smtp.quit()

self.client_evt.set()
self.serv_evt.wait()
self.output.flush()
# The Resent-Bcc headers are deleted before serialization.
del m['Bcc']
del m['Resent-Bcc']
# Add the X-Peer header that DebuggingServer adds
m['X-Peer'] = socket.gethostbyname('localhost')
mexpect = '%s%s\n%s' % (MSG_BEGIN, m.as_string(), MSG_END)
self.assertEqual(self.output.getvalue(), mexpect)
debugout = smtpd.DEBUGSTREAM.getvalue()
Date = re.compile(''.join(("\\\\nDate: ", re.escape(current_date))), re.MULTILINE)
self.assertRegex(debugout, Date)


class NonConnectingTests(unittest.TestCase):

def testNotConnected(self):
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2018-01-13-15-52-00.bpo-28879.aW2gj0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix ``smtplib.send_message`` to add Date header if it is missing as per
RFC5322.