add from-addr support (#582)

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- feature: add `--notification-email-from` parameter [#496](https://github.com/icloud-photos-downloader/icloud_photos_downloader/issues/496)
+
 ## 1.9.0 (2023-02-10)
 
 - fix: replace invalid chars in filenames with '_' [#378](https://github.com/icloud-photos-downloader/icloud_photos_downloader/issues/378)

icloudpd/base.py

@@ -171,6 +171,12 @@
     "Default: SMTP username",
     metavar="<notification_email>",
 )
+@click.option(
+    "--notification-email-from",
+    help="Email address from which you would like to receive email notifications. "
+    "Default: SMTP username or notification-email",
+    metavar="<notification_email_from>",
+)
 @click.option(
     "--notification-script",
     type=click.Path(),
@@ -234,6 +240,7 @@ def main(
         smtp_port,
         smtp_no_tls,
         notification_email,
+        notification_email_from,
         log_level,
         no_progress_bar,
         notification_script,
@@ -290,6 +297,7 @@ def main(
                 smtp_port,
                 smtp_no_tls,
                 notification_email,
+                notification_email_from,
             )
         sys.exit(1)
 

icloudpd/email_notifications.py

@@ -8,11 +8,11 @@
 
 
 def send_2sa_notification(
-        smtp_email, smtp_password, smtp_host, smtp_port, smtp_no_tls, to_addr
+        smtp_email, smtp_password, smtp_host, smtp_port, smtp_no_tls, to_addr, from_addr = None
 ):
     """Send an email notification when 2SA is expired"""
     to_addr = to_addr if to_addr else smtp_email
-    from_addr = smtp_email if smtp_email else to_addr
+    from_addr = from_addr or (f"iCloud Photos Downloader <{smtp_email}>" if smtp_email else to_addr)
     logger = setup_logger()
     logger.info("Sending 'two-step expired' notification via email...")
     smtp = smtplib.SMTP(smtp_host, smtp_port)
@@ -34,7 +34,7 @@ def send_2sa_notification(
 Two-step authentication has expired for the icloud_photos_downloader script.
 Please log in to your server and run the script manually to update two-step authentication."""
 
-    msg = f"From: iCloud Photos Downloader <{from_addr}>\n" + \
+    msg = f"From: {from_addr}\n" + \
         f"To: {to_addr}\nSubject: {subj}\nDate: {date}\n\n{message_text}"
 
     smtp.sendmail(from_addr, to_addr, msg)

tests/test_email_notifications.py

@@ -51,7 +51,7 @@ def test_2sa_required_email_notification(self):
                 "[email protected]", "password1"
             )
             smtp_instance.sendmail.assert_called_once_with(
-                "[email protected]",
+                "iCloud Photos Downloader <[email protected]>",
                 "[email protected]",
                 "From: iCloud Photos Downloader <[email protected]>\n"
                 "To: [email protected]\n"
@@ -98,7 +98,7 @@ def test_2sa_notification_without_smtp_login_and_tls(self):
             smtp_instance.sendmail.assert_called_once_with(
                 "[email protected]",
                 "[email protected]",
-                "From: iCloud Photos Downloader <[email protected]>\n"
+                "From: [email protected]\n"
                 "To: [email protected]\n"
                 "Subject: icloud_photos_downloader: Two step authentication has expired\n"
                 "Date: 01/01/2018 00:00\n\nHello,\n\n"
@@ -136,3 +136,56 @@ def test_2sa_required_notification_script(self):
                 print(result.output)
                 assert result.exit_code == 1
             subprocess_patched.assert_called_once_with(["./test_script.sh"])
+
+    @freeze_time("2018-01-01")
+    def test_2sa_required_email_notification_from(self):
+        base_dir = os.path.normpath(f"tests/fixtures/Photos/{inspect.stack()[0][3]}")
+        if os.path.exists(base_dir):
+            shutil.rmtree(base_dir)
+        os.makedirs(base_dir)
+
+        with vcr.use_cassette("tests/vcr_cassettes/auth_requires_2sa.yml"):
+            with patch("smtplib.SMTP") as smtp:
+                # Pass fixed client ID via environment variable
+                runner = CliRunner(env={
+                    "CLIENT_ID": "EC5646DE-9423-11E8-BF21-14109FE0B321"
+                })
+                result = runner.invoke(
+                    main,
+                    [
+                        "--username",
+                        "[email protected]",
+                        "--password",
+                        "password1",
+                        "--smtp-username",
+                        "[email protected]",
+                        "--smtp-password",
+                        "password1",
+                        "--notification-email",
+                        "JD <[email protected]>",
+                        "--notification-email-from",
+                        "JD <[email protected]>",
+                        "-d",
+                        base_dir,
+                    ],
+                )
+                print(result.output)
+                assert result.exit_code == 1
+            smtp_instance = smtp()
+            smtp_instance.connect.assert_called_once()
+            smtp_instance.starttls.assert_called_once()
+            smtp_instance.login.assert_called_once_with(
+                "[email protected]", "password1"
+            )
+            smtp_instance.sendmail.assert_called_once_with(
+                "JD <[email protected]>",
+                "JD <[email protected]>",
+                "From: JD <[email protected]>\n"
+                "To: JD <[email protected]>\n"
+                "Subject: icloud_photos_downloader: Two step authentication has expired\n"
+                "Date: 01/01/2018 00:00\n\nHello,\n\n"
+                "Two-step authentication has expired for the icloud_photos_downloader script.\n"
+                "Please log in to your server and run the script manually to update two-step "
+                "authentication.",
+            )
+