wagtail-newsletter-django-backend 0.5.10__tar.gz → 0.6.0__tar.gz

{wagtail_newsletter_django_backend-0.5.10 → wagtail_newsletter_django_backend-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wagtail-newsletter-django-backend
-Version: 0.5.10
+Version: 0.6.0
 Summary: An internal Django backend to wagtail-newsletter.
 Author-email: "Taylor C. Richberger" <taylor@axfive.net>
 Maintainer-email: "Taylor C. Richberger" <taylor@axfive.net>

{wagtail_newsletter_django_backend-0.5.10 → wagtail_newsletter_django_backend-0.6.0}/src/wagtail_newsletter_django_backend/__init__.py

@@ -3,4 +3,4 @@
 This is a simple, basic internal backend for wagtail-newsletter, allowing you to manage your mailing lists internally and send them out through Django's standard email capabilities.
 '''
 
-__version__ = '0.5.10'
+__version__ = '0.6.0'

{wagtail_newsletter_django_backend-0.5.10 → wagtail_newsletter_django_backend-0.6.0}/src/wagtail_newsletter_django_backend/admin_viewsets.py

@@ -5,7 +5,7 @@ from .models import Audience, AudienceSegment, Subscriber, Campaign
 @final
 class AudienceViewSet(ModelViewSet):
     model = Audience
-    form_fields = ['site', 'name', 'description', 'smtp_user', 'smtp_password', 'from_email_address', 'from_email_name']
+    form_fields = ['site', 'name', 'description']
     list_display = ['site', 'name', 'description']  # pyright: ignore[reportAssignmentType]
     icon = 'group'
     add_to_admin_menu = False
@@ -35,7 +35,7 @@ class SubscriberViewSet(ModelViewSet):
 @final
 class CampaignViewSet(ModelViewSet):
     model = Campaign
-    form_fields = ['subject', 'audience_segment', 'send_at', 'sent_at', 'html']
+    form_fields = ['subject', 'audience_segment', 'send_at', 'sent_at', 'html', 'from_email_address', 'from_email_name']
     list_display = ['subject', 'audience_segment']  # pyright: ignore[reportAssignmentType]
     icon = 'mail'
     add_to_admin_menu = False

{wagtail_newsletter_django_backend-0.5.10 → wagtail_newsletter_django_backend-0.6.0}/src/wagtail_newsletter_django_backend/campaign_backend.py

@@ -1,3 +1,4 @@
+from collections.abc import Iterable
 from datetime import datetime
 from typing import Any, cast, override
 from django.db import transaction
@@ -8,11 +9,12 @@ from html2text import HTML2Text
 from django.core.mail import get_connection
 from django.core.mail.message import EmailMessage, EmailMultiAlternatives
 from wagtail_newsletter import campaign_backends as wncb, audiences as wna, models as wnm
+from wagtail.models import Site
 import re
 from . import models
 
-_unsubscribe_re = re.compile(r'\[\[unsubscribe\]\]|\\[\\[unsubscribe\\]\\]')
-_manage_re = re.compile(r'\[\[manage\]\]|\\[\\[manage\\]\\]')
+_unsubscribe_re = re.compile(r'\[\[unsubscribe\]\]')
+_manage_re = re.compile(r'\[\[manage\]\]')
 
 h2t = HTML2Text()
 class CampaignBackend(wncb.CampaignBackend):
@@ -27,7 +29,7 @@ class CampaignBackend(wncb.CampaignBackend):
                 name=audience.name,
                 member_count=audience.subscriber_set.filter(verified=True).count(),
             )
-            for audience in models.Audience.objects.all()
+            for audience in cast(Iterable[models.Audience], models.Audience.objects.all())
         ]
 
     @override
@@ -35,7 +37,7 @@ class CampaignBackend(wncb.CampaignBackend):
         self,
         audience_id: str
     ) -> "list[wna.AudienceSegment]":
-        audience = models.Audience.objects.get(id=int(audience_id))
+        audience = cast(models.Audience, models.Audience.objects.get(id=int(audience_id)))
         return [
             wna.AudienceSegment(
                 id=f'{audience_id}/{audience_segment.id}',
@@ -43,7 +45,7 @@ class CampaignBackend(wncb.CampaignBackend):
                 name=audience_segment.name,
                 member_count=audience_segment.subscribers.filter(verified=True).count(),
             )
-            for audience_segment in audience.audience_segment_set.all()
+            for audience_segment in cast(Iterable[models.AudienceSegment], audience.audience_segment_set.all())
         ]
 
     @override
@@ -60,33 +62,39 @@ class CampaignBackend(wncb.CampaignBackend):
         with transaction.atomic():
             audience_segment: models.AudienceSegment | None = None
             if recipients is not None and recipients.segment:
-                audience_segment = models.AudienceSegment.objects.get(id=int(recipients.segment.split('/')[-1]))
+                audience_segment = cast(models.AudienceSegment, models.AudienceSegment.objects.get(id=int(recipients.segment.split('/')[-1])))
 
             campaign: models.Campaign | None
             if campaign_id:
                 int_campaign_id = int(campaign_id)
-                campaign = models.Campaign.objects.filter(id=int_campaign_id).first()
+                campaign = cast(models.Campaign | None, models.Campaign.objects.filter(id=int_campaign_id).first())
                 if campaign is None:
                     # No campaign exists with that ID anymore; recreate it.
-                    campaign = models.Campaign.objects.create(
+                    campaign = cast(models.Campaign, models.Campaign.objects.create(
                         id=int_campaign_id,
                         subject=subject,
                         html=html.strip(),
                         audience_segment=audience_segment,
-                    )
+                        from_email_address=reply_to,
+                        from_email_name=from_name,
+                    ))
                 else:
                     campaign.subject = subject
                     campaign.html = html.strip()
+                    campaign.from_email_address = reply_to
+                    campaign.from_email_name = from_name
                     if audience_segment is not None:
                         campaign.audience_segment = audience_segment
                     campaign.full_clean()
                     campaign.save()
             else:
-                campaign = models.Campaign.objects.create(
+                campaign = cast(models.Campaign, models.Campaign.objects.create(
                     subject=subject,
                     html=html.strip(),
                     audience_segment=audience_segment,
-                )
+                    from_email_address=reply_to,
+                    from_email_name=from_name,
+                ))
             return str(campaign.id)
 
     @override
@@ -95,17 +103,9 @@ class CampaignBackend(wncb.CampaignBackend):
 
     @override
     def send_test_email(self, *, campaign_id: str, email: str) -> None:
-        campaign = models.Campaign.objects.get(id=int(campaign_id))
-        audience: models.Audience
-        if campaign.audience_segment is not None:
-            audience = campaign.audience_segment.audience
-        else:
-            # Build empty audience.  Will have no subscribers, and no smtp data.
-            # This will not work without default data in the config.
-            audience = models.Audience()
-
-        from_address = audience.from_address()
-        user, password = audience.smtp_auth()
+        campaign = cast(models.Campaign, models.Campaign.objects.get(id=int(campaign_id)))
+
+        from_address = campaign.from_address()
 
         _ = send_mail(
             subject=campaign.subject,
@@ -113,21 +113,19 @@ class CampaignBackend(wncb.CampaignBackend):
             from_email=from_address,
             recipient_list=[email],
             html_message=campaign.html,
-            auth_user=user,
-            auth_password=password,
         )
 
     @override
     def send_campaign(self, campaign_id: str) -> None:
         with transaction.atomic():
-            campaign = models.Campaign.objects.get(id=int(campaign_id))
+            campaign = cast(models.Campaign, models.Campaign.objects.get(id=int(campaign_id)))
             if campaign.audience_segment is None:
                 raise RuntimeError("Campaign can't be sent without an audience segment")
 
-            audience = campaign.audience_segment.audience
+            audience = cast(models.Audience, campaign.audience_segment.audience)
 
-            site = audience.site
-            hostname = site.hostname
+            site = cast(Site, audience.site)
+            hostname = cast(str, site.hostname)
             match site.port:
                 case 80:
                     url_base = f'http://{hostname}'
@@ -136,13 +134,9 @@ class CampaignBackend(wncb.CampaignBackend):
                 case port:
                     url_base = f'http://{hostname}:{port}'
 
-            from_address = audience.from_address()
-            user, password = audience.smtp_auth()
+            from_address = campaign.from_address()
 
-            connection: Any = get_connection(  # pyright: ignore[reportAny]
-                username=user,
-                password=password,
-            )
+            connection: Any = get_connection()
 
             def subscriber_message(subscriber: models.Subscriber) -> EmailMessage:
                 unsubscribe_url = url_base + reverse('wagtail_newsletter_django_backend:newsletter_subscriber_unsubscribe', kwargs={'key': subscriber.key})
@@ -187,7 +181,7 @@ class CampaignBackend(wncb.CampaignBackend):
     @override
     def schedule_campaign(self, campaign_id: str, schedule_time: datetime) -> None:
         with transaction.atomic():
-            campaign = models.Campaign.objects.get(id=int(campaign_id))
+            campaign = cast(models.Campaign, models.Campaign.objects.get(id=int(campaign_id)))
             campaign.send_at = schedule_time
             campaign.full_clean()
             campaign.save()
@@ -195,7 +189,7 @@ class CampaignBackend(wncb.CampaignBackend):
     @override
     def unschedule_campaign(self, campaign_id: str) -> None:
         with transaction.atomic():
-            campaign = models.Campaign.objects.get(id=int(campaign_id))
+            campaign = cast(models.Campaign, models.Campaign.objects.get(id=int(campaign_id)))
             campaign.send_at = None
             campaign.full_clean()
             campaign.save()

wagtail_newsletter_django_backend-0.6.0/src/wagtail_newsletter_django_backend/migrations/0004_remove_audience_from_email_address_and_more.py

@@ -0,0 +1,39 @@
+# Generated by Django 5.2.5 on 2026-02-04 04:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('wagtail_newsletter_django_backend', '0003_alter_campaign_audience_segment'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='audience',
+            name='from_email_address',
+        ),
+        migrations.RemoveField(
+            model_name='audience',
+            name='from_email_name',
+        ),
+        migrations.RemoveField(
+            model_name='audience',
+            name='smtp_password',
+        ),
+        migrations.RemoveField(
+            model_name='audience',
+            name='smtp_user',
+        ),
+        migrations.AddField(
+            model_name='campaign',
+            name='from_email_address',
+            field=models.EmailField(blank=True, default=None, help_text='The From address for the email.  If not present, this will default to WAGTAIL_NEWSLETTER_REPLY_TO.', max_length=254, null=True),
+        ),
+        migrations.AddField(
+            model_name='campaign',
+            name='from_email_name',
+            field=models.CharField(blank=True, default=None, help_text='The display name portion of the from email.  If not present, this will default to WAGTAIL_NEWSLETTER_FROM_NAME.', max_length=256, null=True),
+        ),
+    ]

{wagtail_newsletter_django_backend-0.5.10 → wagtail_newsletter_django_backend-0.6.0}/src/wagtail_newsletter_django_backend/models.py

@@ -15,16 +15,12 @@ import string
 from wagtail_newsletter import campaign_backends as wncb
 
 if TYPE_CHECKING:
-    from django.db.models.manager import RelatedManager
+    from django.db.models.manager import RelatedManager, Manager
 
 @lru_cache
-def _default_from_parts() -> tuple[str | None, str | None]:
-    email = cast(str | None, settings.DEFAULT_FROM_EMAIL)
-    name: str | None = None
-    if email:
-        name, email = parseaddr(email)
-        email = email or None
-        name = name or None
+def _default_from_parts() -> tuple[str | None, str]:
+    name = cast(str | None, getattr(settings, 'WAGTAIL_NEWSLETTER_FROM_NAME', None))
+    email = cast(str, settings.WAGTAIL_NEWSLETTER_REPLY_TO)
     return name, email
 
 class SaveDict(TypedDict):
@@ -56,33 +52,6 @@ class Audience(models.Model):
     site: 'models.ForeignKey[Site]' = models.ForeignKey(Site, blank=False, null=False, on_delete=models.CASCADE)
     name: 'models.CharField[str]' = models.CharField(max_length=64, blank=False, null=False)
     description: 'models.TextField[str]' = models.TextField(blank=True, null=False)
-    smtp_user: 'models.CharField[str | None]' = models.CharField(
-        max_length=256,
-        blank=True,
-        null=True,
-        default=None,
-        help_text='The SMTP login user.  If absent, this will not be supplied to send_mail, and EMAIL_HOST_USER will be used instead',
-    )
-    smtp_password: 'models.CharField[str | None]' = models.CharField(
-        max_length=256,
-        blank=True,
-        null=True,
-        default=None,
-        help_text='The SMTP login password.  If absent, this will not be supplied to send_mail, and EMAIL_HOST_PASSWORD will be used instead',
-    )
-    from_email_address: 'models.EmailField[str | None]' = models.EmailField(
-        blank=True,
-        null=True,
-        default=None,
-        help_text='The From address for the email.  If not present, this will not be supplied to send_mail, and DEFAULT_FROM_EMAIL will be used instead',
-    )
-    from_email_name: 'models.CharField[str | None]' = models.CharField(
-        max_length=256,
-        blank=True,
-        null=True,
-        default=None,
-        help_text='The display name portion of the from email.  This will be wrapped around the from email address.',
-    )
 
     created_at: 'models.DateTimeField[datetime]' = models.DateTimeField(auto_now_add=True)
     updated_at: 'models.DateTimeField[datetime]' = models.DateTimeField(auto_now=True)
@@ -99,35 +68,6 @@ class Audience(models.Model):
     def __str__(self) -> str:
         return self.name
 
-    _NULLABLE_FIELDS: Sequence[str] = ('smtp_user', 'smtp_password', 'from_email_address', 'from_email_name')
-
-    @override
-    def save(self, **kwargs: Unpack[SaveDict]) -> None:  # pyright: ignore[reportIncompatibleMethodOverride]
-        patch_blanks(self, kwargs.get('update_fields'), Audience._NULLABLE_FIELDS)
-        return super().save(**kwargs)
-
-    def from_address(self) -> str:
-        default_from_name, default_from_email = _default_from_parts()
-        from_email = self.from_email_address or default_from_email
-        if from_email is None:
-            raise RuntimeError('from email address must be set')
-        from_name = self.from_email_name or default_from_name
-        if from_name:
-            return formataddr((from_name, from_email))
-        else:
-            return from_email
-
-    def smtp_auth(self) -> tuple[str, str]:
-        smtp_user = self.smtp_user or cast(str | None, settings.EMAIL_HOST_USER)
-        smtp_password = self.smtp_password or cast(str | None, settings.EMAIL_HOST_PASSWORD)
-        if smtp_user is None:
-            raise RuntimeError('smtp_user must be set')
-
-        if smtp_password is None:
-            raise RuntimeError('smtp_password must be set')
-
-        return smtp_user, smtp_password
-
 class AudienceSegment(models.Model):
     pk: int
     id: int  # pyright: ignore[reportUninitializedInstanceVariable]
@@ -245,6 +185,8 @@ class Subscription(models.Model):
             raise ValidationError('The audience_segment and subscriber must have the same audience')
 
 class Campaign(models.Model):
+    objects: 'Manager[Campaign]'
+
     pk: int
     id: int # pyright: ignore[reportUninitializedInstanceVariable]
 
@@ -254,9 +196,40 @@ class Campaign(models.Model):
     html: 'models.TextField[str]' = models.TextField(blank=False, null=False)
     audience_segment: 'models.ForeignKey[AudienceSegment | None]' = models.ForeignKey(AudienceSegment, blank=False, null=True, on_delete=models.SET_NULL)
 
+    from_email_address: 'models.EmailField[str | None]' = models.EmailField(
+        blank=True,
+        null=True,
+        default=None,
+        help_text='The From address for the email.  If not present, this will default to WAGTAIL_NEWSLETTER_REPLY_TO.',
+    )
+
+    from_email_name: 'models.CharField[str | None]' = models.CharField(
+        max_length=256,
+        blank=True,
+        null=True,
+        default=None,
+        help_text='The display name portion of the from email.  If not present, this will default to WAGTAIL_NEWSLETTER_FROM_NAME.',
+    )
+
     created_at: 'models.DateTimeField[datetime]' = models.DateTimeField(auto_now_add=True)
     updated_at: 'models.DateTimeField[datetime]' = models.DateTimeField(auto_now=True)
 
+    _NULLABLE_FIELDS: Sequence[str] = ('from_email_address', 'from_email_name')
+
+    @override
+    def save(self, **kwargs: Unpack[SaveDict]) -> None:  # pyright: ignore[reportIncompatibleMethodOverride]
+        patch_blanks(self, kwargs.get('update_fields'), Campaign._NULLABLE_FIELDS)
+        return super().save(**kwargs)
+
+    def from_address(self) -> str:
+        default_from_name, default_from_email = _default_from_parts()
+        from_email = cast(str | None, self.from_email_address) or default_from_email
+        from_name = cast(str | None, self.from_email_name) or default_from_name
+        if from_name:
+            return formataddr((from_name, from_email))
+        else:
+            return from_email
+
     @property
     def is_sent(self) -> bool:
         return self.sent_at is not None