# Copyright (C) 2012-2025 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see .
"""Tests for the LMTP server."""
import os
import smtplib
import unittest
from datetime import datetime
from mailman.app.lifecycle import create_list
from mailman.config import config
from mailman.database.transaction import transaction
from mailman.interfaces.domain import IDomainManager
from mailman.testing.helpers import (
get_lmtp_client,
get_queue_messages,
LogFileMark,
)
from mailman.testing.layers import LMTPLayer
from zope.component import getUtility
class TestLMTPBase(unittest.TestCase):
def _must_lmtp_sendmail(self, *args, **kwargs):
mark = LogFileMark('mailman.smtp')
try:
return self._lmtp.sendmail(*args, *kwargs)
except Exception as e:
log = f"\n{mark.read()}".replace("\n", "\n LMTP runner log: ")
raise Exception(
f"LMTP runner may have failed: {log}",
) from e
class TestLMTP(TestLMTPBase):
"""Test various aspects of the LMTP server."""
layer = LMTPLayer
def setUp(self):
with transaction():
self._mlist = create_list('test@example.com')
self._lmtp = get_lmtp_client(quiet=True)
self._lmtp.lhlo('remote.example.org')
self.addCleanup(self._lmtp.close)
def test_unixfrom_in_message(self):
# Ensure a unixfrom is added to the message object.
self._must_lmtp_sendmail('anne@example.com', ['test@example.com'], """\
From: anne@example.com
To: test@example.com
Subject: Test unixfrom
Message-ID:
""")
items = get_queue_messages('in', expected_count=1)
self.assertEqual('anne@example.com', items[0].msg.get_unixfrom())
def test_message_id_supplied_if_missing(self):
# A Message-ID header is generated if the message doesn't have one.
self._must_lmtp_sendmail('anne@example.com', ['test@example.com'], """\
From: anne@example.com
To: test@example.com
Subject: This has no Message-ID header
""")
items = get_queue_messages('in', expected_count=1)
self.assertIsNotNone(items[0].msg.get('message-id'))
def test_bogus_message_id_is_fixed(self):
# fix bogus Message-ID with []
self._must_lmtp_sendmail('anne@example.com', ['test@example.com'], """\
From: anne@example.com
To: test@example.com
Subject: Bogus [] Message-ID
Message-ID: [bogus@example.com]
""")
items = get_queue_messages('in', expected_count=1)
self.assertEqual('', items[0].msg.get('message-id'))
def test_other_bogus_message_id_is_fixed(self):
# fix bogus Message-ID with <[]>
self._must_lmtp_sendmail('anne@example.com', ['test@example.com'], """\
From: anne@example.com
To: test@example.com
Subject: Bogus <[]> Message-ID
Message-ID: <[bogus@example.com]>
""")
items = get_queue_messages('in', expected_count=1)
self.assertEqual('', items[0].msg.get('message-id'))
def test_message_id_hash_is_added(self):
self._must_lmtp_sendmail('anne@example.com', ['test@example.com'], """\
From: anne@example.com
To: test@example.com
Message-ID:
Subject: This has a Message-ID but no Message-ID-Hash
""")
items = get_queue_messages('in', expected_count=1)
self.assertEqual(items[0].msg['message-id-hash'],
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
def test_original_message_id_hash_is_overwritten(self):
self._must_lmtp_sendmail('anne@example.com', ['test@example.com'], """\
From: anne@example.com
To: test@example.com
Message-ID:
Message-ID-Hash: IGNOREME
Subject: This has a Message-ID but no Message-ID-Hash
""")
items = get_queue_messages('in', expected_count=1)
all_headers = items[0].msg.get_all('message-id-hash')
self.assertEqual(len(all_headers), 1)
self.assertEqual(items[0].msg['message-id-hash'],
'MS6QLWERIJLGCRF44J7USBFDELMNT2BW')
def test_received_time(self):
# The LMTP runner adds a `received_time` key to the metadata.
self._must_lmtp_sendmail('anne@example.com', ['test@example.com'], """\
From: anne@example.com
To: test@example.com
Subject: This has no Message-ID header
Message-ID:
""")
items = get_queue_messages('in', expected_count=1)
self.assertEqual(items[0].msgdata['received_time'],
datetime(2005, 8, 1, 7, 49, 23))
def test_defective_message(self):
# A message with defects should be rejected and logged.
mark = LogFileMark('mailman.smtp')
with self.assertRaises(smtplib.SMTPDataError) as ex:
self._lmtp.sendmail('anne@example.com',
['test@example.com'], """\
From: anne@example.com
To: test@example.com
Subject: This is a defective message
Message-ID:
Body line with no separator
Body
""")
self.assertEqual(501, ex.exception.smtp_code)
self.assertEqual(ex.exception.smtp_error, b'Message has defects: '
b'[MissingHeaderBodySeparatorDefect()]')
self.assertRegex(mark.read(), 'Message rejected with defects\n'
'.*[MissingHeaderBodySeparatorDefect()]')
def test_queue_directory(self):
# The LMTP runner is not queue runner, so it should not have a
# directory in var/queue.
queue_directory = os.path.join(config.QUEUE_DIR, 'lmtp')
self.assertFalse(os.path.isdir(queue_directory))
def test_nonexistent_mailing_list(self):
# Trying to post to a nonexistent mailing list is an error.
with self.assertRaises(smtplib.SMTPRecipientsRefused) as cm:
self._lmtp.sendmail('anne@example.com',
['notalist@example.com'], """\
From: anne.person@example.com
To: notalist@example.com
Subject: An interesting message
Message-ID:
""")
# smtplib.SMTPRecipientsRefused.args contains a list of errors (for
# each RCPT TO), thus we should have only one error
self.assertEqual(len(cm.exception.args), 1)
args0 = cm.exception.args[0]
# each error should be a dict with the corresponding email address
# as key
self.assertTrue('notalist@example.com' in args0)
errorval = args0['notalist@example.com']
# errorval must be a tuple of (code, errorstr)
self.assertEqual(errorval[0], 550)
self.assertEqual(errorval[1],
b'Requested action not taken: mailbox unavailable')
def test_nonexistent_domain(self):
# Trying to post to a nonexistent domain is an error.
with self.assertRaises(smtplib.SMTPRecipientsRefused) as cm:
self._lmtp.sendmail('anne@example.com',
['test@x.example.com'], """\
From: anne.person@example.com
To: test@example.com
Subject: An interesting message
Message-ID:
""")
# smtplib.SMTPRecipientsRefused.args contains a list of errors (for
# each RCPT TO), thus we should have only one error
self.assertEqual(len(cm.exception.args), 1)
args0 = cm.exception.args[0]
# each error should be a dict with the corresponding email address
# as key
self.assertTrue('test@x.example.com' in args0)
errorval = args0['test@x.example.com']
# errorval must be a tuple of (code, errorstr)
self.assertEqual(errorval[0], 550)
self.assertEqual(errorval[1],
b'Requested action not taken: mailbox unavailable')
def test_alias_domain(self):
# Posting to an alias_domain succeeds.
manager = getUtility(IDomainManager)
with transaction():
manager.get('example.com').alias_domain = 'x.example.com'
self._must_lmtp_sendmail('anne@example.com', ['test@x.example.com'],
"""\
From: anne.person@example.com
To: test@example.com
Subject: An interesting message
Message-ID:
""")
items = get_queue_messages('in', expected_count=1)
self.assertMultiLineEqual(items[0].msg.as_string(), """\
From: anne.person@example.com
To: test@example.com
Subject: An interesting message
Message-ID:
Message-ID-Hash: 75E2XSUXAFQGWANWEROVQ7JGYMNWHJBT
X-Message-ID-Hash: 75E2XSUXAFQGWANWEROVQ7JGYMNWHJBT
X-MailFrom: anne@example.com
""")
def test_missing_subaddress(self):
# Trying to send a message to a bogus subaddress is an error.
with self.assertRaises(smtplib.SMTPRecipientsRefused) as cm:
self._lmtp.sendmail('anne@example.com',
['test-bogus@example.com'], """\
From: anne.person@example.com
To: test-bogus@example.com
Subject: An interesting message
Message-ID:
""")
# smtplib.SMTPRecipientsRefused.args contains a list of errors (for
# each RCPT TO), thus we should have only one error
self.assertEqual(len(cm.exception.args), 1)
args0 = cm.exception.args[0]
# each error should be a dict with the corresponding email address
# as key
self.assertTrue('test-bogus@example.com' in args0)
errorval = args0['test-bogus@example.com']
# errorval must be a tuple of (code, errorstr)
self.assertEqual(errorval[0], 550)
self.assertEqual(errorval[1],
b'Requested action not taken: mailbox unavailable')
def test_mailing_list_with_subaddress(self):
# A mailing list with a subaddress in its name should be recognized as
# the mailing list, not as a command.
with transaction():
create_list('test-join@example.com')
self._must_lmtp_sendmail('anne@example.com', ['test-join@example.com'],
"""\
From: anne@example.com
To: test-join@example.com
Message-ID:
Subject: This should not be recognized as a join command
""")
# The message is in the incoming queue but not the command queue.
get_queue_messages('in', expected_count=1)
get_queue_messages('command', expected_count=0)
def test_mailing_list_with_subaddress_command(self):
# Like above, but we can still send a command to the mailing list.
with transaction():
create_list('test-join@example.com')
self._must_lmtp_sendmail('anne@example.com',
['test-join-join@example.com'], """\
From: anne@example.com
To: test-join-join@example.com
Message-ID:
Subject: This will be recognized as a join command.
""")
# The message is in the command queue but not the incoming queue.
get_queue_messages('in', expected_count=0)
get_queue_messages('command', expected_count=1)
def test_mailing_list_with_subaddress_name(self):
# Test that we can post to a list whose name is a subaddress.
with transaction():
create_list('join@example.com')
self._must_lmtp_sendmail('anne@example.com',
['join@example.com'], """\
From: anne@example.com
To: join@example.com
Message-ID:
Subject: This will be recognized as a post to the join list.
""")
# The message is in the incoming queue but not the command queue.
get_queue_messages('in', expected_count=1)
get_queue_messages('command', expected_count=0)
def test_mailing_list_with_subaddress_dash_name(self):
# Test that we can post to a list whose name is -subaddress.
with transaction():
create_list('-join@example.com')
self._must_lmtp_sendmail('anne@example.com',
['-join@example.com'], """\
From: anne@example.com
To: -join@example.com
Message-ID:
Subject: This will be recognized as a post to the -join list.
""")
# The message is in the incoming queue but not the command queue.
get_queue_messages('in', expected_count=1)
get_queue_messages('command', expected_count=0)
def test_mailing_list_with_different_address_and_list_id(self):
# A mailing list can be renamed, in which case the list_name
# will be different but the list_id will remain the same.
# https://gitlab.com/mailman/mailman/issues/428
with transaction():
self._mlist.list_name = 'renamed'
self.assertEqual(self._mlist.posting_address, 'renamed@example.com')
self._must_lmtp_sendmail('anne@example.com', ['renamed@example.com'],
"""\
From: anne@example.com
To: renamed@example.com
Message-ID:
Subject: This should be accepted.
""")
# The message is in the incoming queue but not the command queue.
items = get_queue_messages('in', expected_count=1)
self.assertEqual(items[0].msgdata['listid'], 'test.example.com')
class TestBugs(TestLMTPBase):
"""Test some LMTP related bugs."""
layer = LMTPLayer
def setUp(self):
self._lmtp = get_lmtp_client(quiet=True)
self._lmtp.lhlo('remote.example.org')
def test_lp1117176(self):
# Upper cased list names can't be sent to via LMTP.
with transaction():
create_list('my-LIST@example.com')
self._must_lmtp_sendmail('anne@example.com', ['my-list@example.com'],
"""\
From: anne@example.com
To: my-list@example.com
Subject: My subject
Message-ID:
""")
items = get_queue_messages('in', expected_count=1)
self.assertEqual(items[0].msgdata['listid'],
'my-list.example.com')
def test_issue140(self):
# Non-UTF-8 data sent to the LMTP server crashes it.
with transaction():
create_list('ant@example.com')
self._must_lmtp_sendmail('anne@example.com', ['ant@example.com'], b"""\
From: anne@example.com
To: ant@example.com
Subject: My subject
Message-ID:
\xa0
""")
items = get_queue_messages('in', expected_count=1)
self.assertEqual(items[0].msg['message-id'], '')
def test_issue_836(self):
# Local parts > 64 bytes should be accepted.
with transaction():
create_list('longer_than_15_bytes@example.com')
recip = 'longer_than_15_bytes-confirm+{}@example.com'.format(40*'x')
self._must_lmtp_sendmail('anne@example.com', [recip], """\
From: anne@example.com
To: {}
Subject: confirm
Message-ID:
""".format(recip))
items = get_queue_messages('command', expected_count=1)
self.assertEqual(items[0].msgdata['listid'],
'longer_than_15_bytes.example.com')