feat(api): add publish reminder emails for stale draft dandisets

dandiapi/api/mail.py

@@ -8,6 +8,7 @@
 from django.template.loader import render_to_string
 from django.utils.html import strip_tags
 
+from dandiapi.api.models.email import SentEmail
 from dandiapi.api.services.permissions.dandiset import get_dandiset_owners
 
 if TYPE_CHECKING:
@@ -59,6 +60,13 @@ def build_message(  # noqa: PLR0913
     return email_message
 
 
+def _get_html_content(message) -> str:
+    """Extract HTML content from an EmailMultiAlternatives message."""
+    if message.alternatives:
+        return message.alternatives[0][0]
+    return ''
+
+
 def build_removed_message(dandiset, removed_owner):
     render_context = {
         **BASE_RENDER_CONTEXT,
@@ -87,12 +95,58 @@ def build_added_message(dandiset, added_owner):
     )
 
 
-def send_ownership_change_emails(dandiset, removed_owners, added_owners):
+def send_ownership_change_emails(
+    dandiset, removed_owners, added_owners
+) -> list[SentEmail]:
+    """Send emails when dandiset ownership changes.
+
+    Returns a list of SentEmail records for tracking purposes.
+    """
     messages = [build_removed_message(dandiset, removed_owner) for removed_owner in removed_owners]
     messages += [build_added_message(dandiset, added_owner) for added_owner in added_owners]
+
     with mail.get_connection() as connection:
         connection.send_messages(messages)
 
+    # Record sent emails
+    sent_emails = []
+
+    for removed_owner in removed_owners:
+        message = build_removed_message(dandiset, removed_owner)
+        sent_emails.append(
+            SentEmail.record_email(
+                subject=message.subject,
+                to=list(message.to),
+                text_content=message.body,
+                template_name='ownership_removed',
+                render_context={
+                    'dandiset_identifier': dandiset.identifier,
+                    'dandiset_name': dandiset.draft_version.name,
+                },
+                dandiset=dandiset,
+                recipient_users=[removed_owner],
+            )
+        )
+
+    for added_owner in added_owners:
+        message = build_added_message(dandiset, added_owner)
+        sent_emails.append(
+            SentEmail.record_email(
+                subject=message.subject,
+                to=list(message.to),
+                text_content=message.body,
+                template_name='ownership_added',
+                render_context={
+                    'dandiset_identifier': dandiset.identifier,
+                    'dandiset_name': dandiset.draft_version.name,
+                },
+                dandiset=dandiset,
+                recipient_users=[added_owner],
+            )
+        )
+
+    return sent_emails
+
 
 def build_registered_message(user: User, socialaccount: SocialAccount):
     # Email sent to the DANDI list when a new user logs in for the first time
@@ -106,11 +160,28 @@ def build_registered_message(user: User, socialaccount: SocialAccount):
     )
 
 
-def send_registered_notice_email(user: User, socialaccount: SocialAccount):
+def send_registered_notice_email(user: User, socialaccount: SocialAccount) -> SentEmail:
+    """Send registration notice email.
+
+    Returns the SentEmail record for tracking purposes.
+    """
     logger.info('Sending registration message to %s', user)
-    messages = [build_registered_message(user, socialaccount)]
+    message = build_registered_message(user, socialaccount)
+
     with mail.get_connection() as connection:
-        connection.send_messages(messages)
+        connection.send_messages([message])
+
+    return SentEmail.record_email(
+        subject=message.subject,
+        to=list(message.to),
+        text_content=message.body,
+        template_name='registered_notice',
+        render_context={
+            'user_email': user.email,
+            'greeting_name': user_greeting_name(user, socialaccount),
+        },
+        recipient_users=[user],
+    )
 
 
 def build_new_user_messsage(user: User, socialaccount: SocialAccount = None):
@@ -126,11 +197,27 @@ def build_new_user_messsage(user: User, socialaccount: SocialAccount = None):
     )
 
 
-def send_new_user_message_email(user: User, socialaccount: SocialAccount):
+def send_new_user_message_email(user: User, socialaccount: SocialAccount) -> SentEmail:
+    """Send new user review message to admins.
+
+    Returns the SentEmail record for tracking purposes.
+    """
     logger.info('Sending new user message for %s to admins', user)
-    messages = [build_new_user_messsage(user, socialaccount)]
+    message = build_new_user_messsage(user, socialaccount)
+
     with mail.get_connection() as connection:
-        connection.send_messages(messages)
+        connection.send_messages([message])
+
+    return SentEmail.record_email(
+        subject=message.subject,
+        to=list(message.to),
+        text_content=message.body,
+        template_name='new_user_review',
+        render_context={
+            'username': user.username,
+        },
+        # Note: recipient is admin email, not the user being reviewed
+    )
 
 
 def build_approved_user_message(user: User, socialaccount: SocialAccount = None):
@@ -147,11 +234,28 @@ def build_approved_user_message(user: User, socialaccount: SocialAccount = None)
     )
 
 
-def send_approved_user_message(user: User, socialaccount: SocialAccount):
+def send_approved_user_message(user: User, socialaccount: SocialAccount) -> SentEmail:
+    """Send account approval message.
+
+    Returns the SentEmail record for tracking purposes.
+    """
     logger.info('Sending approved user message to %s', user)
-    messages = [build_approved_user_message(user, socialaccount)]
+    message = build_approved_user_message(user, socialaccount)
+
     with mail.get_connection() as connection:
-        connection.send_messages(messages)
+        connection.send_messages([message])
+
+    return SentEmail.record_email(
+        subject=message.subject,
+        to=list(message.to),
+        text_content=message.body,
+        template_name='user_approved',
+        render_context={
+            'user_email': user.email,
+            'greeting_name': user_greeting_name(user, socialaccount),
+        },
+        recipient_users=[user],
+    )
 
 
 def build_rejected_user_message(user: User, socialaccount: SocialAccount = None):
@@ -168,11 +272,29 @@ def build_rejected_user_message(user: User, socialaccount: SocialAccount = None)
     )
 
 
-def send_rejected_user_message(user: User, socialaccount: SocialAccount):
+def send_rejected_user_message(user: User, socialaccount: SocialAccount) -> SentEmail:
+    """Send account rejection message.
+
+    Returns the SentEmail record for tracking purposes.
+    """
     logger.info('Sending rejected user message to %s', user)
-    messages = [build_rejected_user_message(user, socialaccount)]
+    message = build_rejected_user_message(user, socialaccount)
+
     with mail.get_connection() as connection:
-        connection.send_messages(messages)
+        connection.send_messages([message])
+
+    return SentEmail.record_email(
+        subject=message.subject,
+        to=list(message.to),
+        text_content=message.body,
+        template_name='user_rejected',
+        render_context={
+            'user_email': user.email,
+            'greeting_name': user_greeting_name(user, socialaccount),
+            'rejection_reason': user.metadata.rejection_reason,
+        },
+        recipient_users=[user],
+    )
 
 
 def build_pending_users_message(users: Iterable[User]):
@@ -184,11 +306,29 @@ def build_pending_users_message(users: Iterable[User]):
     )
 
 
-def send_pending_users_message(users: Iterable[User]):
+def send_pending_users_message(users: Iterable[User]) -> SentEmail:
+    """Send pending users review message to admins.
+
+    Returns the SentEmail record for tracking purposes.
+    """
     logger.info('Sending pending users message to admins at %s', settings.DANDI_ADMIN_EMAIL)
-    messages = [build_pending_users_message(users)]
+    users_list = list(users)
+    message = build_pending_users_message(users_list)
+
     with mail.get_connection() as connection:
-        connection.send_messages(messages)
+        connection.send_messages([message])
+
+    return SentEmail.record_email(
+        subject=message.subject,
+        to=list(message.to),
+        text_content=message.body,
+        template_name='pending_users_review',
+        render_context={
+            'user_count': len(users_list),
+            'usernames': [u.username for u in users_list],
+        },
+        # Note: recipient is admin email, users are the subject of the email
+    )
 
 
 def build_dandiset_unembargoed_message(dandiset: Dandiset):
@@ -210,11 +350,30 @@ def build_dandiset_unembargoed_message(dandiset: Dandiset):
     )
 
 
-def send_dandiset_unembargoed_message(dandiset: Dandiset):
+def send_dandiset_unembargoed_message(dandiset: Dandiset) -> SentEmail:
+    """Send dandiset unembargoed notification.
+
+    Returns the SentEmail record for tracking purposes.
+    """
     logger.info('Sending dandisets unembargoed message to dandiset %s owners.', dandiset.identifier)
-    messages = [build_dandiset_unembargoed_message(dandiset)]
+    owners = list(get_dandiset_owners(dandiset))
+    message = build_dandiset_unembargoed_message(dandiset)
+
     with mail.get_connection() as connection:
-        connection.send_messages(messages)
+        connection.send_messages([message])
+
+    return SentEmail.record_email(
+        subject=message.subject,
+        to=list(message.to),
+        text_content=message.body,
+        html_content=_get_html_content(message),
+        template_name='dandiset_unembargoed',
+        render_context={
+            'dandiset_identifier': dandiset.identifier,
+        },
+        dandiset=dandiset,
+        recipient_users=owners,
+    )
 
 
 def build_dandiset_unembargo_failed_message(dandiset: Dandiset):
@@ -234,11 +393,83 @@ def build_dandiset_unembargo_failed_message(dandiset: Dandiset):
     )
 
 
-def send_dandiset_unembargo_failed_message(dandiset: Dandiset):
+def send_dandiset_unembargo_failed_message(dandiset: Dandiset) -> SentEmail:
+    """Send dandiset unembargo failure notification.
+
+    Returns the SentEmail record for tracking purposes.
+    """
     logger.info(
         'Sending dandiset unembargo failed message for dandiset %s to dandiset owners and devs',
         dandiset.identifier,
     )
-    messages = [build_dandiset_unembargo_failed_message(dandiset)]
+    owners = list(get_dandiset_owners(dandiset))
+    message = build_dandiset_unembargo_failed_message(dandiset)
+
     with mail.get_connection() as connection:
-        connection.send_messages(messages)
+        connection.send_messages([message])
+
+    return SentEmail.record_email(
+        subject=message.subject,
+        to=list(message.to),
+        text_content=message.body,
+        html_content=_get_html_content(message),
+        bcc=list(message.bcc) if message.bcc else [],
+        reply_to=list(message.reply_to) if message.reply_to else [],
+        template_name='dandiset_unembargo_failed',
+        render_context={
+            'dandiset_identifier': dandiset.identifier,
+        },
+        dandiset=dandiset,
+        recipient_users=owners,
+    )
+
+
+def build_publish_reminder_message(dandiset: Dandiset):
+    """Build an email reminding dandiset owners to publish their dandiset."""
+    dandiset_context = {
+        'identifier': dandiset.identifier,
+        'name': dandiset.draft_version.name,
+        'ui_link': f'{settings.DANDI_WEB_APP_URL}/dandiset/{dandiset.identifier}',
+    }
+
+    render_context = {
+        **BASE_RENDER_CONTEXT,
+        'dandiset': dandiset_context,
+    }
+    html_message = render_to_string('api/mail/publish_reminder.html', render_context)
+    return build_message(
+        subject=f'Reminder: Publish your Dandiset "{dandiset.draft_version.name}"',
+        message=strip_tags(html_message),
+        html_message=html_message,
+        to=[owner.email for owner in get_dandiset_owners(dandiset)],
+        reply_to=[settings.DANDI_ADMIN_EMAIL],
+    )
+
+
+def send_publish_reminder_message(dandiset: Dandiset) -> SentEmail:
+    """Send an email reminding dandiset owners to publish their dandiset.
+
+    Returns the SentEmail record for tracking purposes.
+    """
+    logger.info('Sending publish reminder message to dandiset %s owners.', dandiset.identifier)
+    owners = list(get_dandiset_owners(dandiset))
+    message = build_publish_reminder_message(dandiset)
+
+    with mail.get_connection() as connection:
+        connection.send_messages([message])
+
+    # Record the sent email
+    return SentEmail.record_email(
+        subject=message.subject,
+        to=list(message.to),
+        text_content=message.body,
+        html_content=_get_html_content(message),
+        reply_to=list(message.reply_to) if message.reply_to else [],
+        template_name='publish_reminder',
+        render_context={
+            'dandiset_identifier': dandiset.identifier,
+            'dandiset_name': dandiset.draft_version.name,
+        },
+        dandiset=dandiset,
+        recipient_users=owners,
+    )