1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
|
"""
Test message and address parsing/formatting functions.
"""
from email.header import Header
from email.headerregistry import Address
from email.message import EmailMessage, Message
from typing import Union
import pytest
from hypothesis import example, given
from hypothesis.strategies import emails
from aiosmtplib.email import (
extract_recipients,
extract_sender,
flatten_message,
parse_address,
quote_address,
)
@pytest.mark.parametrize(
"address, expected_address",
(
('"A.Smith" <asmith+foo@example.com>', "asmith+foo@example.com"),
("Pepé Le Pew <pépe@example.com>", "pépe@example.com"),
("<a@new.topleveldomain>", "a@new.topleveldomain"),
("B. Smith <b@example.com", "b@example.com"),
),
ids=("quotes", "nonascii", "newtld", "missing_end_<"),
)
def test_parse_address_with_display_names(address: str, expected_address: str) -> None:
parsed_address = parse_address(address)
assert parsed_address == expected_address
@given(emails())
@example("email@[123.123.123.123]")
@example("_______@example.com")
def test_parse_address(email: str) -> None:
assert parse_address(email) == email
@pytest.mark.parametrize(
"address, expected_address",
(
('"A.Smith" <asmith+foo@example.com>', "<asmith+foo@example.com>"),
("Pepé Le Pew <pépe@example.com>", "<pépe@example.com>"),
("<a@new.topleveldomain>", "<a@new.topleveldomain>"),
("email@[123.123.123.123]", "<email@[123.123.123.123]>"),
("_______@example.com", "<_______@example.com>"),
("B. Smith <b@example.com", "<b@example.com>"),
),
ids=("quotes", "nonascii", "newtld", "ipaddr", "underscores", "missing_end_quote"),
)
def test_quote_address_with_display_names(address: str, expected_address: str) -> None:
quoted_address = quote_address(address)
assert quoted_address == expected_address
@given(emails())
@example("email@[123.123.123.123]")
@example("_______@example.com")
def test_quote_address(email: str) -> None:
assert quote_address(email) == f"<{email}>"
def test_flatten_message() -> None:
message = EmailMessage()
message["To"] = "bob@example.com"
message["Subject"] = "Hello, World."
message["From"] = "alice@example.com"
message.set_content("This is a test")
flat_message = flatten_message(message)
expected_message = b"""To: bob@example.com\r
Subject: Hello, World.\r
From: alice@example.com\r
Content-Type: text/plain; charset="utf-8"\r
Content-Transfer-Encoding: 7bit\r
MIME-Version: 1.0\r
\r
This is a test\r
"""
assert flat_message == expected_message
@pytest.mark.parametrize(
"message_class, utf8, cte_type, expected_chunk",
(
(Message, False, "7bit", b"=?utf-8?b?w6VsaWNlQGV4YW1wbGUuY29t?="),
(Message, True, "7bit", b"=?utf-8?b?w6VsaWNlQGV4YW1wbGUuY29t?="),
(Message, False, "8bit", b"=?utf-8?b?w6VsaWNlQGV4YW1wbGUuY29t?="),
(Message, True, "8bit", b"=?utf-8?b?w6VsaWNlQGV4YW1wbGUuY29t?="),
(EmailMessage, False, "7bit", b"=?utf-8?q?=C3=A5lice?="),
(EmailMessage, True, "7bit", b"\xc3\xa5lice@example.com"),
(EmailMessage, False, "8bit", b"=?utf-8?q?=C3=A5lice?="),
(EmailMessage, True, "8bit", b"\xc3\xa5lice@example.com"),
),
ids=(
"compat32-ascii-7bit",
"compat32-utf8-7bit",
"compat32-ascii-8bit",
"compat32-utf8-8bit",
"mime-ascii-7bit",
"mime-utf8-7bit",
"mime-ascii-8bit",
"mime-utf8-8bit",
),
)
def test_flatten_message_utf8_options(
message_class: Union[type[EmailMessage], type[Message]],
utf8: bool,
cte_type: str,
expected_chunk: bytes,
) -> None:
message = message_class()
message["From"] = "ålice@example.com"
flat_message = flatten_message(message, utf8=utf8, cte_type=cte_type)
assert expected_chunk in flat_message
def test_flatten_message_removes_bcc_from_message_text() -> None:
message = EmailMessage()
message["Bcc"] = "alice@example.com"
flat_message = flatten_message(message)
assert flat_message == b"\r\n" # empty message
def test_flatten_resent_message() -> None:
message = EmailMessage()
message["To"] = "bob@example.com"
message["Cc"] = "claire@example.com"
message["Bcc"] = "dustin@example.com"
message["Subject"] = "Hello, World."
message["From"] = "alice@example.com"
message.set_content("This is a test")
message["Resent-Date"] = "Mon, 20 Nov 2017 21:04:27 -0000"
message["Resent-To"] = "eliza@example.com"
message["Resent-Cc"] = "fred@example.com"
message["Resent-Bcc"] = "gina@example.com"
message["Resent-Subject"] = "Fwd: Hello, World."
message["Resent-From"] = "hubert@example.com"
flat_message = flatten_message(message)
expected_message = b"""To: bob@example.com\r
Cc: claire@example.com\r
Subject: Hello, World.\r
From: alice@example.com\r
Content-Type: text/plain; charset="utf-8"\r
Content-Transfer-Encoding: 7bit\r
MIME-Version: 1.0\r
Resent-Date: Mon, 20 Nov 2017 21:04:27 -0000\r
Resent-To: eliza@example.com\r
Resent-Cc: fred@example.com\r
Resent-Subject: Fwd: Hello, World.\r
Resent-From: hubert@example.com\r
\r
This is a test\r
"""
assert flat_message == expected_message
@pytest.mark.parametrize(
"mime_to_header,mime_cc_header,compat32_to_header,"
"compat32_cc_header,expected_recipients",
(
(
"Alice Smith <alice@example.com>, hackerman@email.com",
"Bob <Bob@example.com>",
"Alice Smith <alice@example.com>, hackerman@email.com",
"Bob <Bob@example.com>",
["alice@example.com", "hackerman@email.com", "Bob@example.com"],
),
(
Address(display_name="Alice Smith", username="alice", domain="example.com"),
Address(display_name="Bob", username="Bob", domain="example.com"),
Header("Alice Smith <alice@example.com>"),
Header("Bob <Bob@example.com>"),
["alice@example.com", "Bob@example.com"],
),
(
Address(display_name="ålice Smith", username="ålice", domain="example.com"),
Address(display_name="Bøb", username="Bøb", domain="example.com"),
Header("ålice Smith <ålice@example.com>"),
Header("Bøb <Bøb@example.com>"),
["ålice@example.com", "Bøb@example.com"],
),
(
Address(display_name="ålice Smith", username="alice", domain="example.com"),
Address(display_name="Bøb", username="Bob", domain="example.com"),
Header("ålice Smith <alice@example.com>"),
Header("Bøb <Bob@example.com>"),
["alice@example.com", "Bob@example.com"],
),
),
ids=("str", "ascii", "utf8_address", "utf8_display_name"),
)
def test_extract_recipients(
mime_to_header: Union[str, Address],
mime_cc_header: Union[str, Address],
compat32_to_header: Union[str, Header],
compat32_cc_header: Union[str, Header],
expected_recipients: list[str],
) -> None:
mime_message = EmailMessage()
mime_message["To"] = mime_to_header
mime_message["Cc"] = mime_cc_header
mime_recipients = extract_recipients(mime_message)
assert mime_recipients == expected_recipients
compat32_message = Message()
compat32_message["To"] = compat32_to_header
compat32_message["Cc"] = compat32_cc_header
compat32_recipients = extract_recipients(compat32_message)
assert compat32_recipients == expected_recipients
def test_extract_recipients_includes_bcc() -> None:
message = EmailMessage()
message["Bcc"] = "alice@example.com"
recipients = extract_recipients(message)
assert recipients == [message["Bcc"]]
def test_extract_recipients_invalid_email() -> None:
message = EmailMessage()
message["Cc"] = "me"
recipients = extract_recipients(message)
assert recipients == ["me"]
def test_extract_recipients_with_iterable_of_strings() -> None:
message = EmailMessage()
message["To"] = ("me@example.com", "you")
recipients = extract_recipients(message)
assert recipients == ["me@example.com", "you"]
def test_extract_recipients_resent_message() -> None:
message = EmailMessage()
message["To"] = "bob@example.com"
message["Cc"] = "claire@example.com"
message["Bcc"] = "dustin@example.com"
message["Resent-Date"] = "Mon, 20 Nov 2017 21:04:27 -0000"
message["Resent-To"] = "eliza@example.com"
message["Resent-Cc"] = "fred@example.com"
message["Resent-Bcc"] = "gina@example.com"
recipients = extract_recipients(message)
assert message["Resent-To"] in recipients
assert message["Resent-Cc"] in recipients
assert message["Resent-Bcc"] in recipients
assert message["To"] not in recipients
assert message["Cc"] not in recipients
assert message["Bcc"] not in recipients
def test_extract_recipients_valueerror_on_multiple_resent_message() -> None:
message = EmailMessage()
message["Resent-Date"] = "Mon, 20 Nov 2016 21:04:27 -0000"
message["Resent-Date"] = "Mon, 20 Nov 2017 21:04:27 -0000"
with pytest.raises(ValueError):
extract_recipients(message)
@pytest.mark.parametrize(
"mime_header,compat32_header,expected_sender",
(
(
"Alice Smith <alice@example.com>",
"Alice Smith <alice@example.com>",
"alice@example.com",
),
(
Address(display_name="Alice Smith", username="alice", domain="example.com"),
Header("Alice Smith <alice@example.com>"),
"alice@example.com",
),
(
Address(display_name="ålice Smith", username="ålice", domain="example.com"),
Header("ålice Smith <ålice@example.com>", "utf-8"),
"ålice@example.com",
),
(
Address(display_name="ålice Smith", username="alice", domain="example.com"),
Header("ålice Smith <alice@example.com>", "utf-8"),
"alice@example.com",
),
),
ids=("str", "ascii", "utf8_address", "utf8_display_name"),
)
def test_extract_sender(
mime_header: Union[str, Address],
compat32_header: Union[str, Header],
expected_sender: str,
) -> None:
mime_message = EmailMessage()
mime_message["From"] = mime_header
mime_sender = extract_sender(mime_message)
assert mime_sender == expected_sender
compat32_message = Message()
compat32_message["From"] = compat32_header
compat32_sender = extract_sender(compat32_message)
assert compat32_sender == expected_sender
def test_extract_sender_prefers_sender_header() -> None:
message = EmailMessage()
message["From"] = "bob@example.com"
message["Sender"] = "alice@example.com"
sender = extract_sender(message)
assert sender != message["From"]
assert sender == message["Sender"]
def test_extract_sender_resent_message() -> None:
message = EmailMessage()
message["From"] = "alice@example.com"
message["Resent-Date"] = "Mon, 20 Nov 2017 21:04:27 -0000"
message["Resent-From"] = "hubert@example.com"
sender = extract_sender(message)
assert sender == message["Resent-From"]
assert sender != message["From"]
def test_extract_sender_valueerror_on_multiple_resent_message() -> None:
message = EmailMessage()
message["Resent-Date"] = "Mon, 20 Nov 2016 21:04:27 -0000"
message["Resent-Date"] = "Mon, 20 Nov 2017 21:04:27 -0000"
with pytest.raises(ValueError):
extract_sender(message)
|