multi_notifier 0.6.0__tar.gz

multi_notifier-0.6.0/.github/workflows/publish_pypi.yml

@@ -0,0 +1,33 @@
+name: Publish Python Package
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v6
+
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install Python 3.13
+        run: uv python install 3.13
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish

multi_notifier-0.6.0/.github/workflows/run_tests.yml

@@ -0,0 +1,40 @@
+name: Run Tests
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v6
+
+      - name: Install uv and set the Python version
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --frozen --all-groups
+
+      - name: Run Prek Hooks
+        run: |
+          uv run prek run --all-files
+
+      - name: Upload Coverage Report
+        if: always()
+        uses: actions/upload-artifact@v7
+        with:
+          name: coverage-report-${{ matrix.python-version }}
+          path: htmlcov

multi_notifier-0.6.0/.yamlfmt.yaml

@@ -0,0 +1,5 @@
+formatter:
+  type: basic
+  eof_newline: true
+  max_line_length: 120
+  retain_line_breaks_single: true

multi_notifier-0.6.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 N.Seuling
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

multi_notifier-0.6.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: multi_notifier
+Version: 0.6.0
+Summary: notify multiple recipients on multiple protocols
+Author: Seuling N.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: aiogram>=3.27.0
+Requires-Dist: pydantic<3.0.0,>=2.6.0
+Requires-Dist: pyyaml~=6.0
+Requires-Dist: sulguk>=0.11.1

multi_notifier-0.6.0/changelog.md

@@ -0,0 +1,64 @@
+# Version 0.6.0 - 09.04.2026
+
+## Breaking Changes
+
+- renamed Exceptions to Error
+- removed `connector_mail_imap`
+- removed `send_handler`
+
+# Features
+
+- refactored `multi_notifier.connector_mail.Mail` connector to use `email` package (built-in python library)
+- added possibility to send images and html with `multi_notifier.connector_telegram.Telegram`
+- changed to new project structure with pyproject.toml and modern tools like ruff / prek
+
+# Version 0.5.0 - 03.08.2024
+
+## Features
+
+- bumped versions:
+  - requests~=2.32.0
+  - pydantic>=2.6.0,\<3.0.0
+
+# Version 0.4.0 - 19.03.2024
+
+## Breaking Change
+
+- changed `smtp_server` to `smtp_host`
+
+## Features
+
+- refactored config of all connectors to use pydantic validation.
+
+# Version 0.3.0 - 16.03.2024
+
+## Breaking Change
+
+- the mail connector `multi_notifier.connectors.connector_mail` was replaced by a connector which only can send mail. If the IMAP features are needed the following class must be used: `multi_notifier.connectors.connector_mail_imap`
+
+## Features
+
+- changed mail to use the `redmail` package
+
+# Version 0.2.3 - 12.03.2024
+
+## Bugfix
+
+- fixed bug in `multinotifier.conectors.connector_mail.Mail` which prevents sending multiple mails with a large interval
+
+# Version 0.2.2 - 26.09.2023
+
+## General
+
+- switched to nose_helper python package
+
+## Bugfix
+
+- fixed bug which caused a complete crash if one connector could not be initialized
+
+# Version 0.2.1 - 30.10.2022
+
+## Bugfix
+
+- fixed bug which caused a crash if called from debugger
+- added timeout to telegram calls

multi_notifier-0.6.0/multi_notifier/__init__.py

@@ -0,0 +1,3 @@
+"""Init file of send_handler."""
+
+__version__ = "0.6.0"

multi_notifier-0.6.0/multi_notifier/connectors/__init__.py

@@ -0,0 +1 @@
+"""Init file of all connectors."""

multi_notifier-0.6.0/multi_notifier/connectors/connector_mail.py

@@ -0,0 +1,216 @@
+"""Connector for mail."""
+
+import html
+import logging
+import re
+import smtplib
+import ssl
+from email.charset import QP, Charset
+from email.mime.image import MIMEImage
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from email.utils import formatdate, make_msgid
+from pathlib import Path
+
+import pydantic
+
+import multi_notifier.connectors.exceptions
+import multi_notifier.connectors.interface
+
+LOGGER = logging.getLogger(__name__)
+
+
+class MailConfig(pydantic.BaseModel):
+    """Config for mail connector."""
+
+    user: str
+    password: str
+    smtp_host: str
+    smtp_port: int
+
+
+class Mail(multi_notifier.connectors.interface.Interface):
+    """Class to send e-mails."""
+
+    __html_pattern = re.compile(r"<[^<]+?>")
+
+    def __init__(self, mail_config: MailConfig) -> None:
+        """Init Mail class.
+
+        Args:
+            mail_config: config for mail connector
+
+        Raises:
+            multi_notifier.connectors.exceptions.ConnectorConfigurationError: If mail configuration is faulty
+        """
+        self.config = mail_config
+        self.smtp_host = mail_config.smtp_host
+        self.smtp_port = mail_config.smtp_port
+        self.user = mail_config.user
+        self.password = mail_config.password
+
+    def _create_msg(self, recipients: list[str], message: str, subject: str | None = None, images: dict[str, Path] | None = None) -> MIMEMultipart:  # noqa: C901, PLR0915
+        """Create a MIME multipart message with optional images and HTML support.
+
+        Args:
+            recipients: list of recipients (email addresses).
+            message: Message content (plain text or HTML).
+            subject: Subject line of the email. Defaults to "No Subject" if not provided.
+            images: Dictionary mapping Content-ID to image file paths for embedded images.
+
+        Returns:
+            MIMEMultipart: A MIME message object ready to be sent via SMTP.
+
+        Raises:
+            No direct exceptions, but logs warnings if image files are not found.
+        """
+        if images is None:
+            images = {}
+
+        # check if content of message is HTML and set text / HTML
+        is_html = bool(self.__html_pattern.search(message))
+
+        # Create MIME message structure
+        # For emails with images and HTML:
+        #   related - root
+        #   └── alternative (text/html variants)
+        #       ├── text/plain
+        #       └── text/html
+        #   └── image1, image2, ... (embedded images with Content-ID)
+        #
+        # For emails with images and plain text:
+        #   mixed - root
+        #   ├── alternative (text/plain)
+        #   └── image1, image2, ... (regular attachments)
+        #
+        # For emails without images:
+        #   alternative - root
+        #   ├── text/plain
+        #   └── text/html (if HTML)
+        if images and not is_html:
+            # Plain text with images: use multipart/mixed for regular attachments
+            msg = MIMEMultipart("mixed")
+            alternative = MIMEMultipart("alternative")
+            msg.attach(alternative)
+        elif images and is_html:
+            # HTML with images: use multipart/related for embedded images
+            msg = MIMEMultipart("related")
+            alternative = MIMEMultipart("alternative")
+            msg.attach(alternative)
+        else:
+            # No images: simple alternative structure
+            msg = MIMEMultipart("alternative")
+            # Smart alias: When no images exist, msg and alternative point to the same object.
+            # This allows the code below to always use "alternative.attach()" regardless
+            # of whether images are present or not.
+            alternative = msg
+
+        msg["Subject"] = subject or "No Subject"
+        msg["From"] = self.user
+        msg["MIME-Version"] = "1.0"
+        msg["Message-ID"] = make_msgid(domain=self.smtp_host)
+        msg["Date"] = formatdate(localtime=True)
+        msg["To"] = ", ".join(recipients)
+
+        # Add text and HTML parts with explicit UTF-8 charset
+        # Charset encoding: Use quoted-printable to keep emails readable and smaller than base64
+        charset = Charset("utf-8")
+        charset.header_encoding = QP
+        charset.body_encoding = QP
+        if is_html:
+            # Create plain text version from HTML
+            # This provides a fallback for email clients that don't support HTML
+            plain_text = self.__html_pattern.sub("", message)
+            # Clean up extra whitespace and decode HTML entities
+            plain_text = html.unescape(plain_text)
+            plain_text = re.sub(r"\s+", " ", plain_text).strip()
+
+            text_part = MIMEText(plain_text, "plain", _charset="utf-8")
+            html_part = MIMEText(message, "html", _charset="utf-8")
+            # Apply quoted-printable encoding for better email compatibility
+            text_part.set_charset(charset)
+            html_part.set_charset(charset)
+            # Attach both alternatives: email client chooses the best one it can render
+            alternative.attach(text_part)
+            alternative.attach(html_part)
+        else:
+            text_part = MIMEText(message, "plain", _charset="utf-8")
+            text_part.set_charset(charset)
+            alternative.attach(text_part)
+
+        # Add images
+        if is_html:
+            # For HTML messages: embed images with Content-ID for HTML reference
+            # Images are attached to the 'msg' object (the root container), not to 'alternative'.
+            # This ensures images are in the multipart/related structure, allowing them to be
+            # referenced by their Content-ID in HTML img tags: <img src="cid:image_id">
+            for cid, image_path in images.items():
+                try:
+                    img_data = image_path.read_bytes()
+                    img = MIMEImage(img_data)
+                    # Set Content-ID header: allows HTML to reference this image via src="cid:..."
+                    img.add_header("Content-ID", f"<{cid}>")
+                    msg.attach(img)
+                except FileNotFoundError:
+                    LOGGER.warning(f"Image file not found: {image_path}")
+                    continue
+        elif images:
+            # For plain text messages: add images as regular attachments
+            for image_path in images.values():
+                try:
+                    img_data = image_path.read_bytes()
+                    img = MIMEImage(img_data)
+                    # Add filename and disposition for regular attachment
+                    filename = image_path.name
+                    img.add_header("Content-Disposition", f'attachment; filename="{filename}"')
+                    msg.attach(img)
+                except FileNotFoundError:
+                    LOGGER.warning(f"Image file not found: {image_path}")
+                    continue
+
+        return msg
+
+    def send_message(self, recipient: str | list[str], message: str, subject: str | None = None, images: dict[str, Path] | None = None) -> None:
+        """Send a message to one or multiple recipients.
+
+        Args:
+            recipient: one or multiple recipients. (Must be mail addresses!)
+            message: Message which should be sent
+            subject: Subject of the mail
+            images: Images which will be added to the mail
+
+        Raises:
+            multi_notifier.connectors.exceptions.ConnectorError: if mail could not be sent
+        """
+        LOGGER.debug(f"Sending mail to {recipient} with subject '{subject}' and message '{message[:20]}'")
+        recipient_list = recipient if isinstance(recipient, list) else [recipient]
+        msg = self._create_msg(recipient_list, message, subject, images)
+
+        try:
+            # Create SMTP session
+            context = ssl.create_default_context()
+            with smtplib.SMTP(self.smtp_host, self.smtp_port) as server:
+                server.starttls(context=context)
+                server.login(self.user, self.password)
+
+                # Send email
+                server.send_message(msg, to_addrs=recipient_list)
+
+        except Exception as exc:
+            LOGGER.exception(msg := "Could not send mail")
+            raise multi_notifier.connectors.exceptions.ConnectorError(msg) from exc
+
+    @staticmethod
+    def is_valid_recipient(recipient: str) -> bool:
+        """Check if the given recipient is valid.
+
+        Args:
+            recipient: Single recipient which should be checked
+
+        Returns:
+            True if recipient has a supported format, else False.
+        """
+        if re.fullmatch(r"[^@]+@[^@]+\.[^@]+", recipient):
+            return True
+        LOGGER.warning(f"The recipient '{recipient}' is not valid !")
+        return False