django-codenerix-email 4.0.37__py2.py3-none-any.whl → 4.0.39__py2.py3-none-any.whl

codenerix_email/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "4.0.37"
+__version__ = "4.0.39"
 
 __authors__ = [
     "Juan Miguel Taboada Godoy <juanmi@juanmitaboada.com>",

codenerix_email/management/commands/emails_recv.py

@@ -1,4 +1,6 @@
 import re
+from textwrap import dedent
+from argparse import RawTextHelpFormatter
 
 import logging
 
@@ -31,7 +33,94 @@ from imapclient.exceptions import LoginError  # noqa: E402
 class Command(BaseCommand):
     help = "Fetches new emails from the configured IMAP account."
 
+    def create_parser(self, prog_name, subcommand, **kwargs):
+        """
+        Create and return the ArgumentParser instance for this command.
+        We are overriding this to use the RawTextHelpFormatter.
+        """
+        parser = super().create_parser(prog_name, subcommand, **kwargs)
+        parser.formatter_class = RawTextHelpFormatter
+        return parser
+
     def add_arguments(self, parser):
+        parser.epilog = dedent(
+            r"""
+            This command connects to the configured IMAP server, fetches new
+            emails, and saves them as ReceivedEmail objects in the database.
+
+            By default, it processes only unseen emails. You can use the
+            --all option to process all emails in the inbox.
+
+            You can filter by specific IMAP ID, Message-ID, or Tracking ID
+            using the respective options.
+
+            The --rewrite option allows overwriting existing received emails
+            with the same Message-ID.
+
+            Examples:
+                # Fetch unseen emails
+                python manage.py emails_recv
+
+                # Fetch all emails
+                python manage.py emails_recv --all
+
+                # Fetch email by specific IMAP ID
+                python manage.py emails_recv --imap-id 123
+
+                # Fetch email by specific Message-ID
+                python manage.py emails_recv --message-id "<...>"
+
+                # Fetch email by specific Tracking ID
+                python manage.py emails_recv --tracking-id "uuid"
+
+            Make sure to configure the IMAP settings in your Django settings:
+                IMAP_EMAIL_HOST = "imap.example.com"
+                IMAP_EMAIL_PORT = 993
+                IMAP_EMAIL_USER = "your_username"
+                IMAP_EMAIL_PASSWORD = "your_password"
+                IMAP_EMAIL_SSL = True  #  (default: True)
+                IMAP_EMAIL_INBOX_FOLDER = "INBOX"  #  (default: "INBOX")
+                IMAP_EMAIL_SELECTOR = "UNSEEN"  #  (default: "UNSEEN")
+                IMAP_EMAIL_SEEN = True  #  (default: True)
+                IMAP_EMAIL_DELETE = False  #  (default: False)
+                IMAP_EMAIL_FILTERS = {
+                    "SUBJECT": [r".*"],
+                    "FROM": [r".*"],
+                    "MESSAGE-ID": [r".*"],
+                    "TO": [
+                        r"^bounce@becas\.com",
+                        r"^bounces@becas\.com",
+                        r"^no-reply@becas\.com",
+                        r"^hola@becas\.com",
+                        r"^tuasesor@becas\.com",
+                        r"^[a-zA-Z0-9._%+-]+@becas\.com",  # *@becas.com
+                    ],
+                    "BODY_PLAIN": [r".*"],
+                    "BODY_HTML": [r".*"],
+                    "HEADER": [("X-Custom-Header", r".*")],
+                    "BOUNCE_TYPE": ["hard", "soft"],
+                    "BOUNCE_REASON": [r".*"],
+                    "TRACKING_ID": True,
+                }
+
+            Filters are applied using AND logic across different fields and
+            OR logic within the same field.
+
+            The filters works as follows:
+                - SUBJECT, FROM, MESSAGE-ID, TO, BODY_PLAIN, BODY_HTML:
+                  regex match (case-insensitive) against the respective field.
+                - HEADER: tuple of (header name, regex) to match specific headers.
+                - BOUNCE_TYPE: "hard" or "soft" to filter by bounce type.
+                - BOUNCE_REASON: regex to match the bounce reason.
+                - TRACKING_ID: if True, only process emails with a tracking ID.
+
+            If IMAP_EMAIL_FILTERS is not set, all emails are processed.
+
+            Note: This command marks processed emails as read (Seen) to avoid
+            reprocessing them in future runs.
+"""  # noqa: E501
+        )
+
         # Named (optional) arguments
         parser.add_argument(
             "--silent",
@@ -205,7 +294,9 @@ class Command(BaseCommand):
 
         else:
             # Search by UNSEEN
-            messages_ids = server.search(["UNSEEN"])
+            messages_ids = server.search(
+                [getattr(settings, "IMAP_EMAIL_SELECTOR", "UNSEEN")]
+            )
             if self.verbose:
                 self.stdout.write(
                     self.style.SUCCESS(
@@ -244,6 +335,8 @@ class Command(BaseCommand):
                 efrom = msg.get("From")
                 eto = msg.get("To")
                 eid = msg.get("Message-ID")
+                ecc = msg.get("Cc")
+                ebc = msg.get("Bcc")
 
                 # If we can't get a Message-ID, use the IMAP ID as fallback
                 # to avoid duplicates
@@ -305,7 +398,8 @@ class Command(BaseCommand):
                                     self.stdout.write(
                                         self.style.WARNING(
                                             f"Tracking ID {tracking_id} found "
-                                            "but no matching sent email."
+                                            f"for IMAP ID {imap_id} but no "
+                                            "matching sent email."
                                         )
                                     )
 
@@ -328,6 +422,47 @@ class Command(BaseCommand):
                             )
                         headers[header] = decoded_value
 
+                    # Let emails pass based on filtering system
+                    (filter_passed, filter_reason) = self.filter_pass(
+                        subject,
+                        efrom,
+                        eto,
+                        ecc,
+                        ebc,
+                        eid,
+                        body_plain,
+                        body_html,
+                        headers,
+                        bounce_type,
+                        bounce_reason,
+                        tracking_id,
+                    )
+                    if not filter_passed:
+                        if self.verbose:
+                            self.stdout.write(
+                                self.style.NOTICE(
+                                    f"Skipping email with IMAP ID: {imap_id} "
+                                    f"(FILTER: {filter_reason})"
+                                )
+                            )
+
+                        if getattr(settings, "IMAP_EMAIL_DELETE", False):
+                            # Delete the message from the server
+                            server.delete_messages(imap_id)
+                            server.expunge()
+                            if self.verbose:
+                                self.stdout.write(
+                                    self.style.SUCCESS(
+                                        f"Deleted email with IMAP ID: {imap_id}"
+                                    )
+                                )
+
+                        elif getattr(settings, "IMAP_EMAIL_SEEN", True):
+                            # Mark the message as read to avoid reprocessing
+                            server.add_flags(imap_id, [b"\\Seen"])
+
+                        continue
+
                     # Create EmailReceived object if doesn't exist
                     if not email_received:
                         overwriting = False
@@ -360,7 +495,12 @@ class Command(BaseCommand):
                         created_count += 1
                         verb = "Created"
 
+                    # Show info about the processed email
                     if self.verbose:
+                        if overwriting:
+                            style = self.style.MIGRATE_HEADING
+                        else:
+                            style = self.style.WARNING
                         msg = (
                             f"{verb} email with IMAP ID: "
                             f"{imap_id} (link={tracking_id})"
@@ -371,26 +511,40 @@ class Command(BaseCommand):
                             )
                             bounce_reason_str = bounce_reason or "Unknown"
                             self.stdout.write(
-                                self.style.WARNING(
+                                style(
                                     f"{msg} "
                                     f"[{bounce_type_str} bounce, "
                                     f"reason={bounce_reason_str}]"
                                 )
                             )
                         else:
-                            self.stdout.write(self.style.SUCCESS(msg))
+                            if overwriting:
+                                style = self.style.MIGRATE_HEADING
+                            else:
+                                style = self.style.SUCCESS
+                            self.stdout.write(style(msg))
 
                 else:
                     if self.verbose:
                         self.stdout.write(
-                            self.style.WARNING(
+                            self.style.HTTP_INFO(
                                 f"Skipping email with IMAP ID: {imap_id} (DUP)"
                             )
                         )
 
-                # Mark the message as read
-                # (flag \Seen) avoid reprocessing
-                server.add_flags(imap_id, [b"\\Seen"])
+                if getattr(settings, "IMAP_EMAIL_DELETE", False):
+                    # Delete the message from the server
+                    server.delete_messages(imap_id)
+                    server.expunge()
+                    if self.verbose:
+                        self.stdout.write(
+                            self.style.SUCCESS(
+                                f"Deleted email with IMAP ID: {imap_id}"
+                            )
+                        )
+                elif getattr(settings, "IMAP_EMAIL_SEEN", True):
+                    # Mark the message as read otherwise (to avoid reprocessing)
+                    server.add_flags(imap_id, [b"\\Seen"])
 
         return (created_count, overwrite_count)
 
@@ -599,3 +753,112 @@ class Command(BaseCommand):
                     bounce_reason = "Unknown (Subject Keyword)"
 
         return (bounce_type, bounce_reason)
+
+    def filter_pass(
+        self,
+        subject: str,
+        efrom: str,
+        eto: str,
+        ecc: str,
+        ebc: str,
+        eid: str,
+        body_plain: str,
+        body_html: str,
+        headers: dict,
+        bounce_type: Optional[str],
+        bounce_reason: Optional[str],
+        tracking_id: Optional[str],
+    ) -> tuple[bool, str]:
+        """
+        Applies filtering rules to determine if an email should be processed.
+
+        Returns:
+            True if the email should be processed, False otherwise.
+        """
+
+        # Get filters from settings
+        filters = getattr(settings, "IMAP_EMAIL_FILTERS", None)
+        if not filters:
+            # No filters defined, allow processing
+            return (True, "No filters defined, processing all.")
+
+        # Helper function to apply regex list to a value
+        def match_any(value: str, patterns: list) -> bool:
+            for pattern in patterns:
+                if re.search(pattern, value, re.IGNORECASE):
+                    return True  # Match found
+            return False  # No matches
+
+        # Apply filters
+        for key, patterns in filters.items():
+            if key == "SUBJECT" and patterns:
+                if not match_any(subject or "", patterns):
+                    return (False, f"SUBJECT failed: {subject}")
+
+            elif key == "FROM" and patterns:
+                if not match_any(efrom or "", patterns):
+                    return (False, f"FROM failed: {efrom}")
+
+            elif key == "TO" and patterns:
+                if not any(
+                    match_any(targets or "", patterns)
+                    for targets in (
+                        eto or "",
+                        ecc or "",
+                        ebc or "",
+                    )
+                ):
+                    # If no direct match, try more robust email extraction
+                    # Analize only the email addresses
+                    emails = re.split(r"[;,]\s*", eto or "")
+                    emails += re.split(r"[;,]\s*", ecc or "")
+                    emails += re.split(r"[;,]\s*", ebc or "")
+
+                    # Stay only with the email and strip < and > if present
+                    email_only = [
+                        e.split()[-1].strip("<>") for e in emails if e
+                    ]
+
+                    # Check if any of the emails match
+                    if not any(match_any(e, patterns) for e in email_only):
+                        return (False, f"TO failed: {eto}")
+
+            elif key == "MESSAGE-ID" and patterns:
+                if not match_any(eid or "", patterns):
+                    return (False, f"MESSAGE-ID failed: {eid}")
+
+            elif key == "BODY_PLAIN" and patterns:
+                if not match_any(body_plain or "", patterns):
+                    return (False, f"BODY_PLAIN failed: {body_plain}")
+
+            elif key == "BODY_HTML" and patterns:
+                if not match_any(body_html or "", patterns):
+                    return (False, f"BODY_HTML failed: {body_html}")
+
+            elif key == "HEADER" and patterns:
+                header_matched = False
+                for header_name, header_patterns in patterns:
+                    header_value = headers.get(header_name, "")
+                    if match_any(header_value, header_patterns):
+                        header_matched = True
+                        break
+                if not header_matched:
+                    return (False, f"HEADER failed: {headers}")
+
+            elif key == "BOUNCE_TYPE" and patterns:
+                if bounce_type not in patterns:
+                    return (False, f"BOUNCE_TYPE failed: {bounce_type}")
+
+            elif key == "BOUNCE_REASON" and patterns:
+                if not bounce_reason or not match_any(bounce_reason, patterns):
+                    return (
+                        False,
+                        f"BOUNCE_REASON failed: {bounce_reason}",
+                    )
+
+            elif key == "TRACKING_ID" and patterns:
+                if patterns and not tracking_id:
+                    return (False, "TRACKING_ID failed: No tracking ID")
+
+        # If all filters passed, allow processing
+        return (True, "All filters passed.")

codenerix_email/static/codenerix_email/emailreceiveds_rows.html

@@ -12,7 +12,9 @@
     class="text-nowrap">{{row.eto|codenerix}}</td>
 <td
     ng-class="{'info': (!row.email__pk) && (!row.bounce_type), 'warning': row.bounce_type=='S', 'danger': row.bounce_type=='H', 'text-warning': row.bounce_type=='S', 'text-danger': row.bounce_type=='H'}"
-    class="text-nowrap">{{row.subject|codenerix}}</td>
+    class="text-nowrap">
+    <span codenerix-html-compile='row.subject|codenerix:"shorttext:50"'></span>
+</td>
 <td
     ng-class="{'info': (!row.email__pk) && (!row.bounce_type), 'warning': row.bounce_type=='S', 'danger': row.bounce_type=='H', 'text-warning': row.bounce_type=='S', 'text-danger': row.bounce_type=='H'}"
     ng-click="$event.stopPropagation();"

{django_codenerix_email-4.0.37.dist-info → django_codenerix_email-4.0.39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-codenerix-email
-Version: 4.0.37
+Version: 4.0.39
 Summary: Codenerix Email is a module that enables CODENERIX to set send emails in a general manner.
 Home-page: https://github.com/codenerix/django-codenerix-email
 Author: Juan Miguel Taboada Godoy <juanmi@juanmitaboada.com>, Juan Soler Ruiz <soleronline@gmail.com>

{django_codenerix_email-4.0.37.dist-info → django_codenerix_email-4.0.39.dist-info}/RECORD

@@ -1,4 +1,4 @@
-codenerix_email/__init__.py,sha256=nmegdQqWfQuMKIEdzqRtGCeg5es1m1w4_DZMJfzSRcg,149
+codenerix_email/__init__.py,sha256=jy3doviOd16K4l2OxN9UBbjhtzx2zjQmwaHgbqXosnw,149
 codenerix_email/admin.py,sha256=w259UKFk_opGEl6PJjYHXWAHQ_8emgqmiixKT5Rid4A,1180
 codenerix_email/apps.py,sha256=WXqu1XQibDDyCvvQYt2JbTK4GIpW8BNv5DCbRJS2mmk,149
 codenerix_email/forms.py,sha256=38byLGxg1MOLAY1kAYChxYZj64tSgyfRvDcSbIOdV0I,5521
@@ -827,8 +827,8 @@ codenerix_email/.mypy_cache/3.10/zoneinfo/_common.data.json,sha256=e4xbNKL_yQ5h5
 codenerix_email/.mypy_cache/3.10/zoneinfo/_common.meta.json,sha256=5K19XWobpSjKwiv7bZFZRcxsEfoh7b-FhYcmqB-2Iic,1737
 codenerix_email/.mypy_cache/3.10/zoneinfo/_tzpath.data.json,sha256=CFx7Q1XfUhhuNX69prkxyirG8rfvEDCNgEHWQigKC_A,5632
 codenerix_email/.mypy_cache/3.10/zoneinfo/_tzpath.meta.json,sha256=d1HJ_xFBI1orlZSVhH0gHWLI-dJG3zY-ZOlctOl62yU,1765
-codenerix_email/__pycache__/__init__.cpython-310.pyc,sha256=BVGH5_FfAI_IwJgqrXXzP-rsKn-MC6qCbtu3xJnll0g,313
-codenerix_email/__pycache__/__init__.cpython-311.pyc,sha256=ifkZHL6PJ-TFRdhWEpJ9r1KPdQOFN5_n_-lFhu8UVzE,337
+codenerix_email/__pycache__/__init__.cpython-310.pyc,sha256=jR8Y-ZqrC_AzgwY3EjpVl3TOkhtTgWepEoei20YfoQw,313
+codenerix_email/__pycache__/__init__.cpython-311.pyc,sha256=VHHEae6bOdMZRv4BoHz1g5HaZMN7_WmD3aXcpvu2mAY,337
 codenerix_email/__pycache__/__init__.cpython-35.pyc,sha256=dl9lYAgrokJptUj3JAhiqTlX7d_CbncOxZeTc1USc88,308
 codenerix_email/__pycache__/__init__.cpython-37.pyc,sha256=5d1CeFU5DrfnwrRpvSw1bHvLN9hoHXjUA3ln3rXCDo8,306
 codenerix_email/__pycache__/__init__.cpython-39.pyc,sha256=0c6KWU_eOTlF5l9fNWv8l41b0LcfVQNUsqDvJTv2YyU,300
@@ -868,7 +868,7 @@ codenerix_email/management/__pycache__/__init__.cpython-35.pyc,sha256=sBoEWs6zdI
 codenerix_email/management/__pycache__/__init__.cpython-39.pyc,sha256=uPXklfliVd3b8pLOJQT9ZeKcqmJMrGychvt68BsPulY,168
 codenerix_email/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 codenerix_email/management/commands/email_test.py,sha256=SPsiq0s48sEX_G3piNHq-c1gDOH800H2zTvM19ei2LY,5605
-codenerix_email/management/commands/emails_recv.py,sha256=RsUfv5s0XMReQ1Y0LjfLp-LJ4F7nFX2z_T1-QAAWcYY,24897
+codenerix_email/management/commands/emails_recv.py,sha256=4QfIQ2M97T4Y3o7BR1d4nA8UF8bqe81wCMUpiooSzxs,35872
 codenerix_email/management/commands/emails_send.py,sha256=scCFklro4WVMYm-1ataSjUMsPT-Ie5u_DdA55CQcTCQ,7944
 codenerix_email/management/commands/recv_emails.py,sha256=aXmhdXlamiNxRpMIDSKBXUBhkOcwi5l_Pme7jSQUCME,273
 codenerix_email/management/commands/send_emails.py,sha256=a1MnpvZKAEFdXNfmI5oFUkVxy4PZ1AjaJS6GH90zeD0,273
@@ -1613,7 +1613,7 @@ codenerix_email/management/commands/.mypy_cache/3.10/zoneinfo/_tzpath.meta.json,
 codenerix_email/management/commands/__pycache__/__init__.cpython-310.pyc,sha256=3-VfdLuaiBIg4KTIy7GETYTt2-AbfCU0vlH6fFZx7_M,189
 codenerix_email/management/commands/__pycache__/__init__.cpython-311.pyc,sha256=yiqmtIhQMYXWx7g7XT-mvQNgGu_X2ymasWvVxIqPsBE,211
 codenerix_email/management/commands/__pycache__/email_test.cpython-311.pyc,sha256=ql-fe6qem8jGQCu-7Wm3ZCEvzOiVMsCdy0IxOyGnJbo,5946
-codenerix_email/management/commands/__pycache__/emails_recv.cpython-311.pyc,sha256=yhLzihKfS8KIBdf_WKNYaRuCpP5Lhv57Ui5eue0_hnk,20952
+codenerix_email/management/commands/__pycache__/emails_recv.cpython-311.pyc,sha256=2xdfhIh76dxEnxx7wxaDsCeycJM4wRCb14C0CJax6to,30330
 codenerix_email/management/commands/__pycache__/emails_send.cpython-311.pyc,sha256=XSOhv92hH9G4Z9juLmXFTOLCS-oggZBA2TFyKIsxmd8,6868
 codenerix_email/management/commands/__pycache__/recv_emails.cpython-310.pyc,sha256=qzj8puxw6pRAz_ptltybySs2mybOwdoZ8LB7Fw8YMGc,9897
 codenerix_email/management/commands/__pycache__/recv_emails.cpython-311.pyc,sha256=YJoyWZ8Ax_ej7u9_YKjtru8BN8bKlMuvqNiTsLoWYUw,643
@@ -1686,9 +1686,9 @@ codenerix_email/migrations/__pycache__/__init__.cpython-311.pyc,sha256=RbbUUEhcJ
 codenerix_email/migrations/__pycache__/__init__.cpython-35.pyc,sha256=2g70xiMW6oJNkIpRM-0Dr5h7AUac-3xyCXPONxp9BBw,147
 codenerix_email/migrations/__pycache__/__init__.cpython-39.pyc,sha256=qNj2NH0YvoWPnCKxkVZPsEFsbM05y7t1njMskNISdVQ,168
 codenerix_email/static/codenerix_email/emailmessages_rows.html,sha256=NyZpKPSHAAIywJX2ncS0H2bkqOVtMUwAdbYmkC4dKmk,2202
-codenerix_email/static/codenerix_email/emailreceiveds_rows.html,sha256=k7-Qe7Y9mrKRJXl69aVe5hHUvGdyrLbMoh9gkpyCG2U,1976
-django_codenerix_email-4.0.37.dist-info/LICENSE,sha256=IXMIpi75XsrJt1Sznt4EftT9c_4X0C9eqK4tHhH8H48,11339
-django_codenerix_email-4.0.37.dist-info/METADATA,sha256=Y84bu_edEiA6UoycJZCYyUVES1Z9JrJWzOrHVUhrsPI,2676
-django_codenerix_email-4.0.37.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
-django_codenerix_email-4.0.37.dist-info/top_level.txt,sha256=lljSA0iKE_UBEM5gIrGQwioC_i8Jjnp-aR1LFElENgw,16
-django_codenerix_email-4.0.37.dist-info/RECORD,,
+codenerix_email/static/codenerix_email/emailreceiveds_rows.html,sha256=u9DXVdzKhx9WlJgcK_cT2DfGp9bGIKTBn3LDQplB4g4,2032
+django_codenerix_email-4.0.39.dist-info/LICENSE,sha256=IXMIpi75XsrJt1Sznt4EftT9c_4X0C9eqK4tHhH8H48,11339
+django_codenerix_email-4.0.39.dist-info/METADATA,sha256=et_AOcJOU0_8V_DL_Br12lR3UkKeJEI06F1mH-A9o2k,2676
+django_codenerix_email-4.0.39.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
+django_codenerix_email-4.0.39.dist-info/top_level.txt,sha256=lljSA0iKE_UBEM5gIrGQwioC_i8Jjnp-aR1LFElENgw,16
+django_codenerix_email-4.0.39.dist-info/RECORD,,