LightweightMailing 0.1.0__tar.gz

lightweightmailing-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Preston David Curtis Johnson [PrestonDJ]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lightweightmailing-0.1.0/LightweightMailing.egg-info/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: LightweightMailing
+Version: 0.1.0
+Summary: A lightweight SMTP wrapper for the simple sending of single and batched personalised emails.
+Author: PrestonDJ
+License-Expression: MIT
+Project-URL: homepage, https://github.com/prestondj/LightweightMailing
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file

lightweightmailing-0.1.0/LightweightMailing.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+LightweightMailing.egg-info/PKG-INFO
+LightweightMailing.egg-info/SOURCES.txt
+LightweightMailing.egg-info/dependency_links.txt
+LightweightMailing.egg-info/top_level.txt
+mailer/__init__.py
+mailer/mail_client.py
+mailer/sender.py

lightweightmailing-0.1.0/LightweightMailing.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

lightweightmailing-0.1.0/LightweightMailing.egg-info/top_level.txt

@@ -0,0 +1 @@
+mailer

lightweightmailing-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: LightweightMailing
+Version: 0.1.0
+Summary: A lightweight SMTP wrapper for the simple sending of single and batched personalised emails.
+Author: PrestonDJ
+License-Expression: MIT
+Project-URL: homepage, https://github.com/prestondj/LightweightMailing
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file

lightweightmailing-0.1.0/mailer/__init__.py

@@ -0,0 +1,2 @@
+from .sender import send_email, send_batch
+from .mail_client import MailClient

lightweightmailing-0.1.0/mailer/mail_client.py

@@ -0,0 +1,71 @@
+from .sender import send_email, send_batch
+
+class MailClient():
+    """
+    A simple SMTP client to send emails. This is a simple wrapper around the send_email and send_batch functions.
+    """
+
+    def __init__(self, smtp_server: str, port: int, sender_email: str, sender_password: str):
+        """
+        Configure a simple smpt client to send emails. This is a simple wrapper around the send_email and send_batch functions.
+        """
+
+        self.smtp_server = smtp_server
+        self.port = port
+        self.sender_email = sender_email
+        self.sender_password = sender_password
+
+    # wrappers of sender.send_email and send_batch.
+
+    def send_email(self, recipient: str, subject: str, body: str) -> bool:
+        """
+        Sends a single email to the specified recipient.
+
+        Args:
+            recipient (str): The email address of the recipient.
+            subject (str): The subject of the email.
+            body (str): The body content of the email.
+
+        Returns:
+            bool: True if the email was sent successfully, False otherwise.
+        """
+        return send_email(
+            recipient,
+            subject,
+            body,
+            self.sender_email,
+            self.sender_password,
+            self.smtp_server,
+            self.port
+        )
+
+    def send_batch(self, recipients: list, subject: str, body: str, personalisation: dict) -> None:
+        """
+        Sends a batch of emails to the specified recipients. Text may contain personalisation via the personalisation dictionary. Structure:
+
+        dict = {
+            recipient : {
+                "personalisation_key": "personalisation_value"
+            }
+        }
+
+        Args:
+            recipients (list): A list of email addresses to send the email to.
+            subject (str): The subject of the email.
+            body (str): The body content of the email.
+            personalisation (dict): A dictionary containing personalisation data for each recipient.
+
+        Returns:
+            Percentage of successful sends. 
+        """
+
+        return send_batch(
+            recipients,
+            subject,
+            body,
+            personalisation,
+            self.sender_email,
+            self.sender_password,
+            self.smtp_server,
+            self.port
+        )

lightweightmailing-0.1.0/mailer/sender.py

@@ -0,0 +1,112 @@
+import smtplib
+
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+
+def send_email(recipient: str, subject: str, body: str, sender: str, password: str, smtp_server: str, port: int, live_server: smtplib.SMTP = None) -> bool:
+    """
+    Send a single plain-text email.
+
+    Args:
+        recipient: The recipient's email address.
+        subject: The email subject.
+        body: The plain-text message body.
+        sender: The sender's email address.
+        password: The sender's SMTP password.
+        smtp_server: The SMTP server hostname.
+        port: The SMTP server port.
+        live_server: An existing connection, used when sending a batch.
+
+    Returns:
+        True if the message was sent successfully, otherwise False.
+    """
+
+    # build the MIME message shared by both sending paths.
+    msg = MIMEMultipart("alternative")
+    msg["From"] = sender
+    msg["To"] = recipient
+    msg["Subject"] = subject
+    msg.attach(MIMEText(body, "plain"))
+
+    # reuse the caller's connection when sending as part of a batch.
+    if live_server:
+        try:
+            live_server.sendmail(sender, recipient, msg.as_string())
+            return True
+        except Exception as e:
+            print(f"Error sending email to {recipient}: {e}")
+            return False
+
+    # open and authenticate a connection for a standalone message.
+    try:
+        with smtplib.SMTP(smtp_server, port) as server:
+            if port == 587:
+                server.starttls()
+
+            server.login(sender, password)
+            server.sendmail(sender, recipient, msg.as_string())
+        print(f"Email sent successfully to {recipient}")
+        return True
+    
+    except Exception as e:
+        print(f"Error sending email to {recipient}: {e}")
+        return False
+
+def send_batch(recipients: list, subject: str, body: str, personalisation: dict, sender: str, password: str, smtp_server: str, port: int) -> None:
+    """
+    Send personalized plain-text emails over one SMTP connection.
+
+    The personalization mapping is keyed by recipient. Values are substituted
+    into the subject and body using ``str.format`` syntax, such as ``{name}``.
+
+    Args:
+        recipients: The recipient email addresses.
+        subject: The email subject template.
+        body: The plain-text body template.
+        personalisation: Recipient-specific values for template substitution.
+        sender: The sender's email address.
+        password: The sender's SMTP password.
+        smtp_server: The SMTP server hostname.
+        port: The SMTP server port.
+
+    Returns:
+        The fraction of recipients whose messages were sent successfully.
+    """
+
+    success = 0
+    total = len(recipients)
+
+    try:
+        with smtplib.SMTP(smtp_server, port) as server:
+            if port == 587: # explicit TLS
+                server.starttls()
+
+            server.login(sender, password)
+
+            for recipient in recipients:
+                try:
+                    # render templates with values specific to this recipient.
+                    values = personalisation.get(recipient, {})
+                    personalised_subject = subject.format(**values)
+                    personalised_body = body.format(**values)
+
+                    send_email(
+                        recipient,
+                        personalised_subject,
+                        personalised_body,
+                        sender,
+                        password,
+                        smtp_server,
+                        port,
+                        live_server=server,
+                    )
+                    success += 1
+
+                except Exception as e:
+                    print(f"Error sending email to {recipient}: {e}")
+
+    except Exception as e:
+        print(f"Error sending batch emails [No recipient received]: {e}")
+        return 0 # no success
+
+    return success/total # percentage of success

lightweightmailing-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "LightweightMailing"
+version = "0.1.0"
+description = "A lightweight SMTP wrapper for the simple sending of single and batched personalised emails."
+readme = "README.md"
+authors = [
+    {name = "PrestonDJ"}
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent"
+]
+license = "MIT"
+requires-python = ">=3.8"
+dependencies = []
+
+[project.urls]
+homepage = "https://github.com/prestondj/LightweightMailing"

lightweightmailing-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+