django-nativemojo 0.1.10__py3-none-any.whl → 0.1.16__py3-none-any.whl

mojo/apps/aws/migrations/0005_alter_emaildomain_region_delete_s3bucket.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.23 on 2025-09-06 00:10
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('aws', '0004_s3bucket'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='emaildomain',
+            name='region',
+            field=models.CharField(default='us-east-1', help_text='AWS region for SES operations', max_length=64),
+        ),
+        migrations.DeleteModel(
+            name='S3Bucket',
+        ),
+    ]

mojo/apps/aws/models/__init__.py

@@ -0,0 +1,19 @@
+"""
+AWS models package exports
+"""
+
+from .email_domain import EmailDomain
+from .mailbox import Mailbox
+from .incoming_email import IncomingEmail
+from .email_attachment import EmailAttachment
+from .sent_message import SentMessage
+from .email_template import EmailTemplate
+
+__all__ = [
+    "EmailDomain",
+    "Mailbox",
+    "IncomingEmail",
+    "EmailAttachment",
+    "SentMessage",
+    "EmailTemplate",
+]

mojo/apps/aws/models/email_attachment.py

@@ -0,0 +1,99 @@
+from django.db import models
+from mojo.models import MojoModel
+
+
+class EmailAttachment(models.Model, MojoModel):
+    """
+    EmailAttachment
+
+    Represents a single attachment extracted from an incoming email. The binary
+    content is stored in the same inbound S3 bucket as the raw message, and
+    referenced by `stored_as` (e.g., s3://bucket/key).
+
+    Relationships:
+    - incoming_email: FK to IncomingEmail
+    """
+
+    created = models.DateTimeField(auto_now_add=True, editable=False)
+    modified = models.DateTimeField(auto_now=True, db_index=True)
+
+    incoming_email = models.ForeignKey(
+        "aws.IncomingEmail",
+        related_name="attachments",
+        on_delete=models.CASCADE,
+        help_text="The inbound email this attachment belongs to"
+    )
+
+    filename = models.CharField(
+        max_length=512,
+        null=True,
+        blank=True,
+        help_text="Original filename (if provided by the sender)"
+    )
+
+    content_type = models.CharField(
+        max_length=255,
+        null=True,
+        blank=True,
+        help_text="MIME content type (e.g., application/pdf)"
+    )
+
+    size_bytes = models.IntegerField(
+        default=0,
+        help_text="Size of the stored attachment in bytes (approximate)"
+    )
+
+    stored_as = models.CharField(
+        max_length=512,
+        help_text="Storage reference (e.g., s3://bucket/key)"
+    )
+
+    metadata = models.JSONField(
+        default=dict,
+        blank=True,
+        help_text="Arbitrary metadata (e.g., content-id, part headers)"
+    )
+
+    class Meta:
+        db_table = "aws_email_attachment"
+        indexes = [
+            models.Index(fields=["modified"]),
+            models.Index(fields=["filename"]),
+        ]
+        ordering = ["-created", "id"]
+
+    class RestMeta:
+        VIEW_PERMS = ["manage_aws"]
+        SAVE_PERMS = ["manage_aws"]
+        DELETE_PERMS = ["manage_aws"]
+        SEARCH_FIELDS = ["filename", "content_type", "stored_as"]
+        GRAPHS = {
+            "basic": {
+                "fields": [
+                    "id",
+                    "incoming_email",
+                    "filename",
+                    "content_type",
+                    "size_bytes",
+                    "created",
+                ],
+                "graphs": {"incoming_email": "basic"},
+            },
+            "default": {
+                "fields": [
+                    "id",
+                    "incoming_email",
+                    "filename",
+                    "content_type",
+                    "size_bytes",
+                    "stored_as",
+                    "metadata",
+                    "created",
+                    "modified",
+                ],
+                "graphs": {"incoming_email": "basic"},
+            },
+        }
+
+    def __str__(self) -> str:
+        return self.filename or self.stored_as or f"Attachment {self.pk}"

mojo/apps/aws/models/email_domain.py

@@ -0,0 +1,218 @@
+from django.db import models
+from mojo.models import MojoModel, MojoSecrets
+from mojo.helpers.settings import settings
+from mojo.helpers.aws.ses_domain import audit_domain_config, reconcile_domain_config
+from mojo.helpers import aws
+
+
+class EmailDomain(MojoSecrets, MojoModel):
+    """
+    EmailDomain
+
+    Minimal model for managing an SES-backed email domain configuration in MOJO.
+
+    Notes:
+    - 'name' is the domain (e.g., example.com).
+    - 'region' defaults to project AWS region (settings.AWS_REGION) or 'us-east-1'.
+    - 'receiving_enabled' toggles domain-level catch-all receiving (SES receipt rules).
+    - 's3_inbound_bucket' and 's3_inbound_prefix' identify where inbound emails are stored.
+    - 'status' is a lightweight lifecycle indicator: pending | verified | error (free-form for now).
+    - 'metadata' allows flexible per-domain extension without schema churn.
+    """
+
+    created = models.DateTimeField(auto_now_add=True, editable=False)
+    modified = models.DateTimeField(auto_now=True, db_index=True)
+
+    name = models.CharField(max_length=255, unique=True, db_index=True)
+    region = models.CharField(
+        max_length=64,
+        default=getattr(settings, 'AWS_REGION', 'us-east-1'),
+        help_text="AWS region for SES operations"
+    )
+
+    status = models.CharField(
+        max_length=32,
+        default='pending',
+        db_index=True,
+        help_text='Domain status: "pending" (created), "ready" (audit passed), or "missing" (audit failed)'
+    )
+
+    receiving_enabled = models.BooleanField(
+        default=False,
+        help_text="When true, domain-level catch-all receiving is enabled via SES receipt rules"
+    )
+
+    s3_inbound_bucket = models.CharField(
+        max_length=255,
+        null=True,
+        blank=True,
+        help_text="S3 bucket for inbound emails (required if receiving_enabled)"
+    )
+    s3_inbound_prefix = models.CharField(
+        max_length=255,
+        default='',
+        blank=True,
+        help_text="S3 prefix for inbound emails (e.g., inbound/example.com/)"
+    )
+
+    dns_mode = models.CharField(
+        max_length=32,
+        default='manual',
+        help_text="DNS automation mode: manual | route53 | godaddy"
+    )
+
+    sns_topic_bounce_arn = models.CharField(
+        max_length=512,
+        null=True,
+        blank=True,
+        help_text="SNS topic ARN for SES bounce notifications"
+    )
+    sns_topic_complaint_arn = models.CharField(
+        max_length=512,
+        null=True,
+        blank=True,
+        help_text="SNS topic ARN for SES complaint notifications"
+    )
+    sns_topic_delivery_arn = models.CharField(
+        max_length=512,
+        null=True,
+        blank=True,
+        help_text="SNS topic ARN for SES delivery notifications"
+    )
+    sns_topic_inbound_arn = models.CharField(
+        max_length=512,
+        null=True,
+        blank=True,
+        help_text="SNS topic ARN for SES inbound notifications"
+    )
+
+    metadata = models.JSONField(default=dict, blank=True)
+
+    # Computed readiness flags updated by audit runs
+    can_send = models.BooleanField(
+        default=False,
+        help_text="True if outbound sending is ready per last audit"
+    )
+    can_recv = models.BooleanField(
+        default=False,
+        help_text="True if inbound receiving is ready per last audit"
+    )
+
+    class Meta:
+        db_table = "aws_email_domain"
+        indexes = [
+            models.Index(fields=["status"]),
+            models.Index(fields=["modified"]),
+        ]
+        ordering = ["name"]
+
+    class RestMeta:
+        VIEW_PERMS = ["manage_aws"]
+        SAVE_PERMS = ["manage_aws"]
+        DELETE_PERMS = ["manage_aws"]
+        SEARCH_FIELDS = ["name", "region", "status"]
+        GRAPHS = {
+            "basic": {
+                "fields": [
+                    "id",
+                    "name",
+                    "region",
+                    "status",
+                    "receiving_enabled",
+                ]
+            },
+            "default": {
+                "fields": [
+                    "id",
+                    "name",
+                    "region",
+                    "status",
+                    "receiving_enabled",
+                    "s3_inbound_bucket",
+                    "s3_inbound_prefix",
+                    "dns_mode",
+                    "sns_topic_bounce_arn",
+                    "sns_topic_complaint_arn",
+                    "sns_topic_delivery_arn",
+                    "sns_topic_inbound_arn",
+                    "metadata",
+                    "created",
+                    "modified",
+                ],
+                "extra": [
+                    "aws_key",
+                    "aws_secret_masked"
+                ]
+            },
+        }
+
+    @property
+    def aws_key(self):
+        return self.get_secret('aws_key')
+
+    @property
+    def aws_secret(self):
+        return self.get_secret('aws_secret')
+
+    @property
+    def aws_secret_masked(self):
+        secret = self.get_secret('aws_secret', '')
+        if len(secret) > 4:
+            return '*' * (len(secret) - 4) + secret[-4:]
+        return secret
+
+
+    @property
+    def aws_region(self):
+        return self.region or getattr(settings, 'AWS_REGION', 'us-east-1')
+
+    @property
+    def is_verified(self):
+        return self.status in ["verified", "ready"]
+
+    def set_aws_key(self, key):
+        self.set_secret('aws_key', key)
+
+    def set_aws_secret(self, secret):
+        self.set_secret('aws_secret', secret)
+
+    def on_rest_created(self):
+        """
+        Automatically audit and reconcile SES/SNS configuration after this domain is created.
+        This keeps AWS-side resources aligned without requiring a separate call.
+        """
+        try:
+            region = self.aws_region
+            # Audit current state (best-effort; ignore failures)
+            try:
+                desired_receiving = None
+                if self.receiving_enabled and self.s3_inbound_bucket:
+                    desired_receiving = {
+                        'bucket': self.s3_inbound_bucket,
+                        'prefix': self.s3_inbound_prefix or '',
+                        'rule_set': 'mojo-default-receiving',
+                        'rule_name': f'mojo-{self.name}-catchall',
+                    }
+                audit_domain_config(
+                    domain=self.name,
+                    region=region,
+                    desired_receiving=desired_receiving,
+                )
+            except Exception:
+                # Non-fatal: continue with reconcile
+                pass
+
+            # Reconcile (idempotent): ensure topics/mappings and catch-all receipt rule if enabled
+            reconcile_domain_config(
+                domain=self.name,
+                region=region,
+                receiving_enabled=self.receiving_enabled,
+                s3_bucket=self.s3_inbound_bucket,
+                s3_prefix=self.s3_inbound_prefix or '',
+            )
+        except Exception:
+            # Swallow exceptions to avoid failing the create call; details can be inspected via /audit
+            pass
+
+    def __str__(self) -> str:
+        return self.name

mojo/apps/aws/models/email_template.py

@@ -0,0 +1,132 @@
+from django.db import models
+from django.template import Template, Context
+from mojo.models import MojoModel
+
+
+class EmailTemplate(models.Model, MojoModel):
+    """
+    EmailTemplate
+
+    Stores Django template strings for subject, HTML, and plain text bodies.
+    Used to render outbound emails with templating support.
+
+    Rendering:
+      - Call `render_all(context)` to render subject, text, and html.
+      - Any of the template fields can be blank; rendering will return None for blanks.
+
+    Notes:
+      - Locale/i18n variations can be added later by introducing a related table or locale key.
+      - This model does not send emails itself; use the email service or REST endpoint
+        to send using rendered content.
+    """
+
+    created = models.DateTimeField(auto_now_add=True, editable=False)
+    modified = models.DateTimeField(auto_now=True, db_index=True)
+
+    name = models.CharField(
+        max_length=255,
+        unique=True,
+        db_index=True,
+        help_text="Unique template name (used by callers to reference this template)"
+    )
+
+    subject_template = models.TextField(
+        blank=True,
+        default="",
+        help_text="Django template string for the email subject"
+    )
+    html_template = models.TextField(
+        blank=True,
+        default="",
+        help_text="Django template string for the HTML body"
+    )
+    text_template = models.TextField(
+        blank=True,
+        default="",
+        help_text="Django template string for the plain text body"
+    )
+
+    metadata = models.JSONField(
+        default=dict,
+        blank=True,
+        help_text="Arbitrary metadata for this template (e.g., description, tags)"
+    )
+
+    class Meta:
+        db_table = "aws_email_template"
+        indexes = [
+            models.Index(fields=["modified"]),
+            models.Index(fields=["name"]),
+        ]
+        ordering = ["name"]
+
+    class RestMeta:
+        VIEW_PERMS = ["manage_aws"]
+        SAVE_PERMS = ["manage_aws"]
+        DELETE_PERMS = ["manage_aws"]
+        SEARCH_FIELDS = ["name"]
+        GRAPHS = {
+            "basic": {
+                "fields": [
+                    "id",
+                    "name",
+                    "created",
+                    "modified",
+                ]
+            },
+            "default": {
+                "fields": [
+                    "id",
+                    "name",
+                    "subject_template",
+                    "html_template",
+                    "text_template",
+                    "metadata",
+                    "created",
+                    "modified",
+                ]
+            },
+        }
+
+    def __str__(self) -> str:
+        return self.name
+
+    # --- Rendering helpers -------------------------------------------------
+
+    @staticmethod
+    def _render_template(tpl_str: str, context: dict | None) -> str | None:
+        """
+        Render a Django template string with the provided context.
+        Returns None if tpl_str is empty.
+        """
+        if not tpl_str:
+            return None
+        # Using Django's Template/Context is sufficient for inline strings.
+        # For more advanced usage or custom engines, we can wire in django.template.engines.
+        try:
+            tpl = Template(tpl_str)
+            ctx = Context(context or {})
+            return tpl.render(ctx)
+        except Exception as e:
+            # We deliberately re-raise to let callers decide how to handle failures.
+            raise e
+
+    def render_subject(self, context: dict | None = None) -> str | None:
+        return self._render_template(self.subject_template, context)
+
+    def render_html(self, context: dict | None = None) -> str | None:
+        return self._render_template(self.html_template, context)
+
+    def render_text(self, context: dict | None = None) -> str | None:
+        return self._render_template(self.text_template, context)
+
+    def render_all(self, context: dict | None = None) -> dict:
+        """
+        Render subject, text, and html templates with the provided context.
+        Returns a dict with keys: subject, text, html (values can be None).
+        """
+        return {
+            "subject": self.render_subject(context),
+            "text": self.render_text(context),
+            "html": self.render_html(context),
+        }

mojo/apps/aws/models/incoming_email.py

@@ -0,0 +1,197 @@
+from django.db import models
+from mojo.models import MojoModel
+
+
+class IncomingEmail(models.Model, MojoModel):
+    """
+    IncomingEmail
+
+    Represents a single inbound email received via SES and stored in S3.
+    Raw MIME is stored in S3 (s3_object_url). Parsed metadata and content are
+    stored in this model. Attachments are stored in the same inbound S3 bucket
+    and represented in a separate model (EmailAttachment, added later).
+
+    Routing:
+    - This model may be associated to a Mailbox if any recipient matches.
+    - An async handler (on the Mailbox) can process the message after creation.
+    """
+
+    created = models.DateTimeField(auto_now_add=True, editable=False)
+    modified = models.DateTimeField(auto_now=True, db_index=True)
+
+    mailbox = models.ForeignKey(
+        "aws.Mailbox",
+        null=True,
+        blank=True,
+        related_name="incoming_emails",
+        on_delete=models.CASCADE,
+        help_text="Associated mailbox if any recipient matches"
+    )
+
+    # Storage and identity
+    s3_object_url = models.CharField(
+        max_length=512,
+        help_text="S3 URL for the raw MIME message (e.g., s3://bucket/key)"
+    )
+    message_id = models.CharField(
+        max_length=255,
+        null=True,
+        blank=True,
+        db_index=True,
+        help_text="SMTP Message-ID header (if present)"
+    )
+
+    # Headers and addressing
+    from_address = models.CharField(
+        max_length=512,
+        null=True,
+        blank=True,
+        help_text="Raw From header address (may include name)"
+    )
+    to_addresses = models.JSONField(
+        default=list,
+        blank=True,
+        help_text="List of recipient addresses from To header"
+    )
+    cc_addresses = models.JSONField(
+        default=list,
+        blank=True,
+        help_text="List of recipient addresses from Cc header"
+    )
+    subject = models.CharField(
+        max_length=512,
+        null=True,
+        blank=True,
+        help_text="Email subject"
+    )
+    date_header = models.DateTimeField(
+        null=True,
+        blank=True,
+        help_text="Parsed Date header from the message"
+    )
+    headers = models.JSONField(
+        default=dict,
+        blank=True,
+        help_text="All headers as a JSON object (flattened)"
+    )
+
+    # Content
+    text_body = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Extracted plain text body (if available)"
+    )
+    html_body = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Extracted HTML body (if available)"
+    )
+
+    # Misc
+    size_bytes = models.IntegerField(
+        default=0,
+        help_text="Approximate size of the raw message in bytes"
+    )
+    received_at = models.DateTimeField(
+        null=True,
+        blank=True,
+        db_index=True,
+        help_text="Time message was received (from SNS/S3 event or set by parser)"
+    )
+
+    # Processing status
+    processed = models.BooleanField(
+        default=False,
+        help_text="True if post-receive processing completed"
+    )
+    process_status = models.CharField(
+        max_length=32,
+        default="pending",
+        db_index=True,
+        help_text="Processing status: pending | success | error"
+    )
+    process_error = models.TextField(
+        null=True,
+        blank=True,
+        help_text="Error details if processing failed"
+    )
+
+    class Meta:
+        db_table = "aws_incoming_email"
+        indexes = [
+            models.Index(fields=["modified"]),
+            models.Index(fields=["received_at"]),
+            models.Index(fields=["message_id"]),
+        ]
+        ordering = ["-received_at", "-created"]
+
+    class RestMeta:
+        VIEW_PERMS = ["manage_aws"]
+        SAVE_PERMS = ["manage_aws"]
+        DELETE_PERMS = ["manage_aws"]
+        SEARCH_FIELDS = ["subject", "from_address", "message_id"]
+        GRAPHS = {
+            "basic": {
+                "fields": [
+                    "id",
+                    "mailbox",
+                    "subject",
+                    "from_address",
+                    "to_addresses",
+                    "received_at",
+                    "processed",
+                    "process_status",
+                    "created",
+                ],
+                "graphs": {"mailbox": "basic"}
+            },
+            "default": {
+                "fields": [
+                    "id",
+                    "mailbox",
+                    "s3_object_url",
+                    "message_id",
+                    "from_address",
+                    "to_addresses",
+                    "cc_addresses",
+                    "subject",
+                    "date_header",
+                    "headers",
+                    "size_bytes",
+                    "received_at",
+                    "processed",
+                    "process_status",
+                    "process_error",
+                    "created",
+                    "modified",
+                ],
+                "graphs": {"mailbox": "basic"}
+            },
+            "full": {
+                "fields": [
+                    "id",
+                    "mailbox",
+                    "s3_object_url",
+                    "message_id",
+                    "from_address",
+                    "to_addresses",
+                    "cc_addresses",
+                    "subject",
+                    "date_header",
+                    "headers",
+                    "text_body",
+                    "html_body",
+                    "size_bytes",
+                    "received_at",
+                    "processed",
+                    "process_status",
+                    "process_error",
+                    "created",
+                    "modified",
+                ],
+                "graphs": {"mailbox": "basic"}
+            },
+        }
+
+    def __str__(self) -> str:
+        return self.subject or self.message_id or f"IncomingEmail {self.pk}"